epuber 0.7.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af051eead00739e08c4b2aa7b4dcd418eee3c8dacbe4ba14f03d59eb0b0c5c9c
-  data.tar.gz: d5d6bac0ca3655ac9a121c9f259ea550015d4395ca39c7a403ea6937ba469809
+  metadata.gz: 603ed8123e624a5756c2e66ef8e2561f76f60b7c2ba386040e62cc1bace24c52
+  data.tar.gz: bc9fd362419d5fd05444398221f8d0e9bbfa4675273635b893c3a160a3330048
 SHA512:
-  metadata.gz: 49e6fd074fc50782e9227aac3ccd45997eb1760ca3e85acc3c14ac4f1660e8d77df877df1981993320ed432b5e9222fca02482813d25ec8e8464c6f6e0c93016
-  data.tar.gz: b26d34e7bbbb3903ab99d6f1b731854602e92a942aee598d2590fa44b9df292212eaa2242e6c8370f75f9d3fdd6d71310ed3a39684366aa29b7033d9bd5c36dd
+  metadata.gz: 5f04920782210213a3c5fb8e424d8b22e3a316d83187dae331057759d4bda04b61b81c163215086fa4cad4abd736de37db43c428b56b51472f8d93c9bbadb5e3
+  data.tar.gz: a683e1930bf8c58b8b9f64529ac55c50dbe0895af5acbb4d4820cf1f5d0559349e87cd3f02c0bf7a90c77b04d4a9a07acee849cb867f8f81a658484e74514e35

data/Gemfile

@@ -5,7 +5,15 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in Epuber.gemspec
 gemspec
 
+# dev
+gem 'fakefs', '>= 1.3', '< 3.0' # 2.0.0 is not compatible with Ruby 2.5
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.2'
+gem 'rubocop', '~> 1.14'
+
+# VSCode plugins
+gem 'ruby-lsp', require: false
+
 group :dev, optional: true do
-  gem 'debase', require: false
-  gem 'ruby-debug-ide', require: false
+  gem 'rubocop-rspec', require: false
 end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Roman Kříž
+Copyright (c) 2015-2023 Roman Kříž
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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):
@@ -103,9 +104,9 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-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.
+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](https://www.contributor-covenant.org/) code of conduct.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](./LICENSE.txt).

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'
@@ -13,23 +11,24 @@ Gem::Specification.new do |spec|
   spec.homepage = Epuber::HOME_URL
   spec.license  = 'MIT'
   spec.required_ruby_version = '>= 2.5'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  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 'uuidtools', '~> 2.1'
 
   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 +36,8 @@ 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_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
+  spec.add_runtime_dependency 'coffee-script', '~> 2.4'
+  spec.add_runtime_dependency 'css_parser', '>= 0.8', '< 2.0'
+  spec.add_runtime_dependency 'epuber-stylus', '~> 1.1', '>= 1.1.1'
 end

data/lib/epuber/book/contributor.rb

@@ -31,22 +31,26 @@ module Epuber
 
       # Creates new instance of Contributor dependent on obj content
       #
-      # @param obj [Hash<Symbol, String>, Array<Hash<Symbol,String>, String, Array<String>] input object
-      # @param role [String] role of contributor
+      # @param [Hash<Symbol, String>, Array<Hash<Symbol,String>, String, Array<String>] obj input object
+      # @param [String] role role of contributor
       #
       # @return [Contributor]
       #
-      def self.from_obj(obj, role)
+      def self.from_obj(obj, role = 'aut')
         if obj.is_a?(String)
-          components = obj.split(' ')
+          components = obj.split
           if components.length >= 2
             NormalContributor.new(components.first(components.length - 1).join(' '), components.last, role)
+          else
+            Contributor.new(obj, obj, role)
           end
         elsif obj.is_a?(Hash)
           if obj.key?(:first_name)
-            NormalContributor.new(obj[:first_name], obj[:last_name], role)
+            NormalContributor.new(obj[:first_name], obj[:last_name], obj[:role] || role)
           elsif obj.key?(:file_as)
-            Contributor.new(obj[:pretty_name], obj[:file_as], role)
+            Contributor.new(obj[:pretty_name], obj[:file_as], obj[:role] || role)
+          elsif obj.key?(:name)
+            Contributor.from_obj(obj[:name], obj[:role] || role)
           end
         end
       end
@@ -73,7 +77,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
@@ -45,10 +45,10 @@ module Epuber
       # @return [Numeric]
       #
       def hash
-        @source_pattern.hash ^ @group.hash ^ @only_one.hash
+        [@source_pattern, @group, @only_one].hash
       end
 
-      # @param other [String, self]
+      # @param [String, self] other
       #
       def ==(other)
         if other.is_a?(String)

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
@@ -217,8 +215,8 @@ module Epuber
                 inherited: false
 
 
-      # @param file_path [String | Epuber::Book::File]
-      # @param group [Symbol]
+      # @param [String | Epuber::Book::File] file_path
+      # @param [Symbol] group
       #
       # @return [Epuber::Book::File] created file
       #
@@ -240,7 +238,7 @@ module Epuber
         end
       end
 
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -251,8 +249,8 @@ module Epuber
         end
       end
 
-      # @param key [String]
-      # @param value [String]
+      # @param [String] key
+      # @param [String] value
       #
       # @return [void]
       #
@@ -264,8 +262,7 @@ module Epuber
         end
       end
 
-
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -281,7 +278,7 @@ module Epuber
       # Add default styles to default target, default styles will be automatically added to xhtml document
       #
       # Only difference with #add_default_style is it adds multiple files with one pattern
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -294,7 +291,7 @@ module Epuber
         end
       end
 
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -310,7 +307,7 @@ module Epuber
       # Add default scripts to target, default scripts will be automatically added to xhtml document
       #
       # Only difference with #add_default_script is it adds multiple files with one pattern
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -333,7 +330,7 @@ module Epuber
         yield(@root_toc, self) if block_given?
       end
 
-      # @param path [String] use some file/module/package
+      # @param [String] path use some file/module/package
       #
       # @return [nil]
       #

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,11 +156,11 @@ module Epuber
     # @return [Array<Contributor>] authors of book
     #
     attribute :authors,
-              types:        [Contributor, NormalContributor],
-              container:    Array,
-              required:     true,
-              singularize:  true,
-              auto_convert: { [String, Hash] => ->(value) { Contributor.from_obj(value, 'aut') } }
+              types: [Contributor, NormalContributor],
+              container: Array,
+              required: true,
+              singularize: true,
+              auto_convert: { [String, Hash] => ->(value) { Contributor.from_obj(value) } }
 
 
     # @return [String] publisher name
@@ -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)
@@ -294,7 +294,7 @@ module Epuber
 
     # Finds target with name or nil when not found
     #
-    # @param target_name [Symbol, String, Epuber::Book::Target]
+    # @param [Symbol, String, Epuber::Book::Target] target_name
     #
     # @return [Epuber::Book::Target, nil]
     #

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

@@ -10,9 +10,9 @@ module Epuber
   class Checker
     class TextChecker < Checker
       class MatchProblem < Compiler::Problem
-        # @param message [String]
-        # @param file_path [String]
-        # @param match [MatchData]
+        # @param [String] message
+        # @param [String] file_path
+        # @param [MatchData] match
         #
         def initialize(match, message, file_path)
           whole_text = match.pre_match + match.matched_string + match.post_match
@@ -36,8 +36,8 @@ module Epuber
 
 
 
-      # @param file_path [String]
-      # @param text [String]
+      # @param [String] file_path
+      # @param [String] text
       # @param [CompilationContext] compilation_context
       #
       # @return nil
@@ -52,7 +52,7 @@ module Epuber
         @file_path = nil
       end
 
-      # @param regexp [Regexp]
+      # @param [Regexp] regexp
       # @param [String] message  message to display, when the regexp found something
       #
       def should_not_contain(regexp, message)
@@ -61,9 +61,18 @@ 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
+
+      def error(message, location: nil)
+        super(message, location: location || Config.instance.pretty_path_from_project(file_path))
+      end
+
+      def warning(message, location: nil)
+        super(message, location: location || Config.instance.pretty_path_from_project(file_path))
+      end
     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]
+    # @param [Symbol] type
     #
     # @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