epuber 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af051eead00739e08c4b2aa7b4dcd418eee3c8dacbe4ba14f03d59eb0b0c5c9c
-  data.tar.gz: d5d6bac0ca3655ac9a121c9f259ea550015d4395ca39c7a403ea6937ba469809
+  metadata.gz: 6f0fcab4dfe82bc1ae829738a62f4915f02e79bbc105ab9eafd6d2c0a664dc60
+  data.tar.gz: 4fcaf730a6caf5d560a1525b5a2a000d29efec2819c82e7c1fdd1bc4cd470228
 SHA512:
-  metadata.gz: 49e6fd074fc50782e9227aac3ccd45997eb1760ca3e85acc3c14ac4f1660e8d77df877df1981993320ed432b5e9222fca02482813d25ec8e8464c6f6e0c93016
-  data.tar.gz: b26d34e7bbbb3903ab99d6f1b731854602e92a942aee598d2590fa44b9df292212eaa2242e6c8370f75f9d3fdd6d71310ed3a39684366aa29b7033d9bd5c36dd
+  metadata.gz: 4fd75c5cda4801241fa762d728308c3c1ebe9d668cc8cf4f9c7be3b3df48ca4715ec2498a2a4914a0c138c21adf49ecdcc66f49e47a33d0487107dd4b05a4d1b
+  data.tar.gz: 14e7bb639a81535df13bde1f5f92ecb29cf2892d5692d93ee1b97b1045cd650c4480cccfc7262280e2ad135a31796cb04932993d6e0dac21f0cbfaa226544045

data/Gemfile

@@ -6,6 +6,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :dev, optional: true do
-  gem 'debase', require: false
-  gem 'ruby-debug-ide', require: false
+  gem 'rubocop-rspec', require: false
 end

data/README.md

@@ -4,6 +4,7 @@
 
 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.
 
+For more information look at [documentation](./docs/README.md).
 
 ## Features
 
@@ -71,7 +72,7 @@ First of all Epuber uses [RMagick](https://github.com/rmagick/rmagick) which has
 - pkg-config
 
 On OS X make sure you Xcode Command Line Tools installed:
-    
+
     xcode-select --install
 
 And the easiest way to install prerequisites on macOS is to use [brew](http://brew.sh):

data/epuber.gemspec

@@ -1,8 +1,6 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'epuber/version'
+# frozen_string_literal: true
 
+require_relative 'lib/epuber/version'
 
 Gem::Specification.new do |spec|
   spec.name     = 'epuber'
@@ -14,22 +12,22 @@ Gem::Specification.new do |spec|
   spec.license  = 'MIT'
   spec.required_ruby_version = '>= 2.5'
 
-  spec.files         = Dir['bin/**/*'] + Dir['lib/**/*'] + %w(epuber.gemspec Gemfile LICENSE.txt README.md)
+  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', '>= 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'
   spec.add_runtime_dependency 'listen', '~> 3.0'
+  spec.add_runtime_dependency 'mime-types', '~> 3.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.2'
   spec.add_runtime_dependency 'os', '~> 1.0'
 
   spec.add_runtime_dependency 'sinatra', '>= 2.0', '< 4.0'
-  spec.add_runtime_dependency 'sinatra-websocket', '~> 0.3'
   spec.add_runtime_dependency 'sinatra-contrib', '>= 2.0', '< 4.0'
+  spec.add_runtime_dependency 'sinatra-websocket', '~> 0.3'
   spec.add_runtime_dependency 'thin', '~> 1.6'
 
   spec.add_runtime_dependency 'rmagick', '>= 4.2', '< 6.0'
@@ -37,12 +35,12 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'epubcheck-ruby', '>= 4.0', '< 6.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.3', '>= 0.3.1'
+  spec.add_runtime_dependency 'coffee-script', '~> 2.4'
+  spec.add_runtime_dependency 'epuber-stylus', '~> 1.1', '>= 1.1.1'
 
+  spec.add_development_dependency 'fakefs', '>= 1.3', '< 3.0' # 2.0.0 is not compatible with Ruby 2.5
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'rubocop', '~> 1.14'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'fakefs', '>= 1.3', '< 3.0' # 2.0.0 is not compatible with Ruby 2.5
 end

data/lib/epuber/book/contributor.rb

@@ -73,7 +73,6 @@ module Epuber
         @last_name  = last_name
       end
 
-
       # @return [String]
       #
       def pretty_name

data/lib/epuber/book/file_request.rb

@@ -29,7 +29,7 @@ module Epuber
       # @param [Symbol] group group of file, see Epuber::Compiler::FileFinder::GROUP_EXTENSIONS
       # @param [Array<Symbol>, Set<Symbol>] properties list of properties
       #
-      def initialize(source_pattern, only_one = true, group: nil, properties: [])
+      def initialize(source_pattern, only_one: true, group: nil, properties: [])
         @source_pattern = source_pattern
         @only_one       = only_one
         @group          = group

data/lib/epuber/book/target.rb

@@ -12,7 +12,7 @@ module Epuber
       # @param [Target] parent  reference to parent target
       # @param [String] name  name of this target
       #
-      def initialize(parent = nil, name)
+      def initialize(name, parent: nil)
         super(parent)
 
         @name      = name
@@ -51,7 +51,7 @@ module Epuber
 
       # @return [Array<self>] list of sub targets
       #
-      alias_method :sub_targets, :sub_items
+      alias sub_targets sub_items
 
       # @return [Epuber::Book::TocItem]
       #
@@ -59,16 +59,14 @@ module Epuber
 
       # @return [Epuber::Book] reference to book
       #
-      attr_accessor :book
-
+      attr_writer :book
 
       # @return [Epuber::Book] reference to book
       #
       def book
-        @book || (parent && parent.book)
+        @book || parent&.book
       end
 
-
       # Create new sub_target with name
       #
       # @param [String] name
@@ -77,7 +75,7 @@ module Epuber
       #
       def sub_target(name)
         child = create_child_item(name)
-        child.book = self.book
+        child.book = book
 
         yield child if block_given?
 
@@ -92,7 +90,7 @@ module Epuber
       #
       def sub_abstract_target(name)
         child = create_child_item(name)
-        child.book = self.book
+        child.book = book
         child.is_abstract = true
 
         yield child if block_given?
@@ -119,9 +117,7 @@ module Epuber
         # parent files plus our files
         all_files = ((parent && parent.files) || []) + @files + @default_styles + @default_scripts
 
-        unless @attributes_values[:cover_image].nil?
-          all_files << @attributes_values[:cover_image]
-        end
+        all_files << @attributes_values[:cover_image] unless @attributes_values[:cover_image].nil?
 
         all_files
       end
@@ -130,7 +126,7 @@ module Epuber
       # @return [Hash<String, Object>]
       #
       def constants
-        ((parent && parent.constants) || {}).merge(@constants)
+        (parent&.constants || {}).merge(@constants)
       end
 
       # @return [Array<Epuber::Book::FileRequest>]
@@ -158,8 +154,8 @@ module Epuber
       # @return [String] version of result epub
       #
       attribute :epub_version,
-                required:     true,
-                inherited:    true,
+                required: true,
+                inherited: true,
                 auto_convert: { [String, Integer, Float] => Version },
                 default_value: 3.0
 
@@ -176,38 +172,40 @@ module Epuber
       # @return [String] target will use custom font (for iBooks only)
       #
       attribute :custom_fonts,
-                types:     [TrueClass, FalseClass],
+                types: [TrueClass, FalseClass],
                 inherited: true
 
       # @return [Bool] hint for compiler to add some iBooks related stuff
       #
       attribute :is_ibooks,
-                types:     [TrueClass, FalseClass],
+                types: [TrueClass, FalseClass],
                 inherited: true
 
       # @return [Bool] whether the target uses fixed layout
       #
       attribute :fixed_layout,
-                types:     [TrueClass, FalseClass],
+                types: [TrueClass, FalseClass],
                 inherited: true
 
       # @return [FileRequest] file request to cover image
       #
       attribute :cover_image,
-                types:        [FileRequest],
-                inherited:    true,
-                auto_convert: { [String] => ->(value) { FileRequest.new(value, group: :image, properties: [:cover_image]) } }
+                types: [FileRequest],
+                inherited: true,
+                auto_convert: { [String] => lambda { |value|
+                                              FileRequest.new(value, group: :image, properties: [:cover_image])
+                                            } }
 
       # @return [Size] size of view port, mainly this is used for fixed layout
       #
       attribute :default_viewport,
-                types:     [Size],
+                types: [Size],
                 inherited: true
 
       # @return [Bool] whether the target should create mobi
       #
       attribute :create_mobi,
-                types:     [TrueClass, FalseClass],
+                types: [TrueClass, FalseClass],
                 inherited: true
 
       # @return [Bool] allows to create abstract targets that are only used as template for other targets
@@ -264,7 +262,6 @@ module Epuber
         end
       end
 
-
       # @param file_paths [Array<String>]
       #
       # @return [void]

data/lib/epuber/book/toc_item.rb

@@ -11,7 +11,7 @@ module Epuber
       #
       attribute :file_request,
                 auto_convert: { String => FileRequest },
-                inherited:    true
+                inherited: true
 
       # @return [String]
       #
@@ -91,9 +91,7 @@ module Epuber
               item.file_request = file_obj
             end
 
-            unless file_fragment.nil? || file_fragment.empty?
-              item.file_fragment = file_fragment
-            end
+            item.file_fragment = file_fragment unless file_fragment.nil? || file_fragment.empty?
           end
 
           if title.is_a?(String)

data/lib/epuber/book.rb

@@ -61,12 +61,12 @@ module Epuber
         @default_target.send(sym)
       end
 
-      unless readonly
-        # setter
-        setter_method = sym.to_s + '='
-        define_method(setter_method) do |newValue|
-          @default_target.send(setter_method, newValue)
-        end
+      return if readonly
+
+      # setter
+      setter_method = "#{sym}="
+      define_method(setter_method) do |new_value|
+        @default_target.send(setter_method, new_value)
       end
     end
 
@@ -78,7 +78,7 @@ module Epuber
     # @return [Array<Target>]
     #
     def all_targets
-      if @default_target.sub_targets.length == 0
+      if @default_target.sub_targets.empty?
         [@default_target]
       else
         @default_target.sub_targets
@@ -86,7 +86,7 @@ module Epuber
     end
 
     def flat_all_targets
-      if @default_target.sub_targets.length == 0
+      if @default_target.sub_targets.empty?
         [@default_target]
       else
         @default_target.flat_sub_items
@@ -94,7 +94,7 @@ module Epuber
     end
 
     def buildable_targets
-      flat_all_targets.select { |t| !t.is_abstract }
+      flat_all_targets.reject(&:is_abstract)
     end
 
     # Defines new target
@@ -125,7 +125,8 @@ module Epuber
     #
     def targets(*names, &block)
       if names.empty?
-        UI.warning('Book#targets to get all targets is deprecated, use #all_targets instead', location: caller_locations.first)
+        UI.warning('Book#targets to get all targets is deprecated, use #all_targets instead',
+                   location: caller_locations.first)
         return all_targets
       end
 
@@ -155,10 +156,10 @@ module Epuber
     # @return [Array<Contributor>] authors of book
     #
     attribute :authors,
-              types:        [Contributor, NormalContributor],
-              container:    Array,
-              required:     true,
-              singularize:  true,
+              types: [Contributor, NormalContributor],
+              container: Array,
+              required: true,
+              singularize: true,
               auto_convert: { [String, Hash] => ->(value) { Contributor.from_obj(value, 'aut') } }
 
 
@@ -214,7 +215,7 @@ module Epuber
     # @return [Date] date of book was published
     #
     attribute :published,
-              types:        [Date],
+              types: [Date],
               auto_convert: { String => Date }
 
 
@@ -222,14 +223,14 @@ module Epuber
     # @note Is used only for ibooks versions
     #
     attribute :version,
-              inherited:    true,
-              types:        [Version],
+              inherited: true,
+              types: [Version],
               auto_convert: { [String, Integer, Float] => Version }
 
     # @return [String] build version of book
     #
     attribute :build_version,
-              types:        [Version],
+              types: [Version],
               auto_convert: { [String, Integer, Float] => Version }
 
     # @return [String] base name for output epub file
@@ -250,7 +251,6 @@ module Epuber
       @default_target.add_files(*file_paths)
     end
 
-
     # Add constant to target, constants can be used within text files
     #
     def add_const(*args)

data/lib/epuber/checker/bookspec_checker.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../checker'
+
+module Epuber
+  class Checker
+    class BookspecChecker < Checker
+      # @return [Epuber::Book]
+      #
+      attr_reader :book
+
+      # @param [Epuber::Book] book
+      # @param [CompilationContext] compilation_context
+      #
+      # @return nil
+      #
+      def call(book, compilation_context)
+        @book = book
+
+        @block.call(self, book, compilation_context)
+
+        @book = nil
+      end
+    end
+  end
+end

data/lib/epuber/checker/text_checker.rb

@@ -61,7 +61,8 @@ module Epuber
         matches = text.to_enum(:scan, regexp).map { Regexp.last_match }
         matches.each do |match|
           # @type match [MatchData]
-          UI.print_processing_problem MatchProblem.new(match, message, Config.instance.pretty_path_from_project(file_path))
+          UI.print_processing_problem MatchProblem.new(match, message,
+                                                       Config.instance.pretty_path_from_project(file_path))
         end
       end
     end

data/lib/epuber/checker.rb

@@ -5,14 +5,28 @@ require_relative 'checker_transformer_base'
 module Epuber
   class Checker < CheckerTransformerBase
     require_relative 'checker/text_checker'
+    require_relative 'checker/bookspec_checker'
 
     # @return [Hash<Symbol, Class>]
     #
     def self.map_source_type__class
       {
-        :result_text_xhtml_string => TextChecker,
-        :source_text_file         => TextChecker,
+        result_text_xhtml_string: TextChecker,
+        source_text_file: TextChecker,
+        bookspec: BookspecChecker,
       }.merge(super)
     end
+
+    def warning(messsage, location: nil)
+      UI.warning(messsage, location: location)
+    end
+
+    def error(messsage, location: nil)
+      if Config.instance.release_build
+        UI.error!(messsage, location: location)
+      else
+        UI.error(messsage, location: location)
+      end
+    end
   end
 end

data/lib/epuber/checker_transformer_base.rb

@@ -2,7 +2,6 @@
 
 module Epuber
   class CheckerTransformerBase
-
     # Type of source value for this checker, valid values are:
     #    :result_text_xhtml_string     just before writing result xhtml to build folder
     #
@@ -41,8 +40,6 @@ module Epuber
       [:run_only_before_release]
     end
 
-
-
     def call(*args)
       raise NotImplementedError, 'You should override this method'
     end
@@ -58,14 +55,14 @@ module Epuber
       {}
     end
 
-
     # @param type [Symbol]
     #
     # @return [Class]
     #
     def self.class_for_source_type(type)
-      checker_class = self.map_source_type__class[type]
+      checker_class = map_source_type__class[type]
       raise "#{self} class not found for type: #{type.inspect}" if checker_class.nil?
+
       checker_class
     end
   end

data/lib/epuber/command/build.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 require 'os'
 
 require_relative '../command'
+require_relative '../epubcheck'
 
 module Epuber
   class Command
@@ -50,48 +51,47 @@ module Epuber
       def run
         super
 
-        puts "compiling book `#{Config.instance.pretty_path_from_project(book.file_path)}`"
+        UI.puts "building book `#{Config.instance.pretty_path_from_project(book.file_path)}`"
 
         if @release_version
           # Remove all previous versions of compiled files
-          targets.each do |target|
-            build_path = Epuber::Config.instance.release_build_path(target)
-
-            if ::File.directory?(build_path)
-              FileUtils.remove_dir(build_path, true)
-            end
-          end
+          cleanup_build_folders
 
           # Build all targets to always clean directory
           targets.each do |target|
+            Epuber::Config.instance.release_build = true
+
             compiler = Epuber::Compiler.new(book, target)
             build_path = Epuber::Config.instance.release_build_path(target)
             compiler.compile(build_path, check: true, write: @should_write,
-                                       release: true, verbose: verbose?,
-                                     use_cache: false)
+                                         release: true, verbose: verbose?,
+                                         use_cache: false)
 
             archive_name = compiler.epub_name
 
-            if ::File.exist?(archive_name)
-              FileUtils.remove_file(archive_name)
-            end
+            FileUtils.remove_file(archive_name) if ::File.exist?(archive_name)
 
             archive_path = compiler.archive(archive_name)
 
-            system(%(epubcheck "#{archive_path}"))
+            Epubcheck.check(archive_path)
+
+            convert_epub_to_mobi(archive_path, "#{::File.basename(archive_path, '.epub')}.mobi") if target.create_mobi
 
-            convert_epub_to_mobi(archive_path, ::File.basename(archive_path, '.epub') + '.mobi') if target.create_mobi
+            Epuber::Config.instance.release_build = false
           end
+
+          # Build all targets to always clean directory
         else
           targets.each do |target|
             compiler = Epuber::Compiler.new(book, target)
             build_path = Epuber::Config.instance.build_path(target)
-            compiler.compile(build_path, check: @should_check, write: @should_write, verbose: verbose?, use_cache: @use_cache)
+            compiler.compile(build_path, check: @should_check, write: @should_write, verbose: verbose?,
+                                         use_cache: @use_cache)
             archive_path = compiler.archive(configuration_suffix: 'debug')
 
-            system(%(epubcheck "#{archive_path}")) if @should_check
+            Epubcheck.check(archive_path) if @should_check
 
-            convert_epub_to_mobi(archive_path, ::File.basename(archive_path, '.epub') + '.mobi') if target.create_mobi
+            convert_epub_to_mobi(archive_path, "#{::File.basename(archive_path, '.epub')}.mobi") if target.create_mobi
           end
         end
 
@@ -103,7 +103,7 @@ module Epuber
       # @return [Array<Epuber::Book::Target>]
       #
       def targets
-        @targets ||= (
+        @targets ||= begin
           targets = @targets_names
 
           # when the list of targets is nil pick all available targets
@@ -112,7 +112,7 @@ module Epuber
           else
             targets.map { |target_name| book.target_named(target_name) }
           end
-        )
+        end
       end
 
       def verify_all_targets_exists!
@@ -121,9 +121,9 @@ module Epuber
       end
 
       def validate_dir(path)
-        if ::File.directory?(path)
-          path
-        end
+        return unless ::File.directory?(path)
+
+        path
       end
 
       def find_calibre_app
@@ -141,7 +141,9 @@ module Epuber
           ::File.join(find_calibre_app, 'Contents/MacOS/ebook-convert')
         elsif OS.linux?
           script_path = '/usr/bin/ebook-convert'
-          UI.error!("Can't find ebook-convert in folder /usr/bin to convert EPUB to MOBI.") unless ::File.executable?(script_path)
+          unless ::File.executable?(script_path)
+            UI.error!("Can't find ebook-convert in folder /usr/bin to convert EPUB to MOBI.")
+          end
           script_path
         else
           UI.error!('Unsupported OS to convert EPUB to MOBI.')
@@ -151,6 +153,14 @@ module Epuber
       def convert_epub_to_mobi(epub_path, mobi_path)
         system(find_calibre_convert_file, epub_path, mobi_path)
       end
+
+      def cleanup_build_folders
+        targets.each do |target|
+          build_path = Epuber::Config.instance.release_build_path(target)
+
+          FileUtils.remove_dir(build_path, true) if ::File.directory?(build_path)
+        end
+      end
     end
   end
 end