epuber 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdced1dd2ebd0dc9d67e06757560ed5acd26d93303db343b53985b3c7aeebe20
-  data.tar.gz: e979d0957ff1a554bc4f29cb4e2bbe6cd0a113a83a42ed46a6e80c8f049e8008
+  metadata.gz: 6190500e356c8d6fd0d642f6e39f2f606948933bee1b17f1285add446e5bdd6d
+  data.tar.gz: 63719103a8cce152f0cbb63ba72ab086064e0f5cbaf03c926fad293342be1c42
 SHA512:
-  metadata.gz: b2ea5b2448b893e8c1c6cb47d4868cdfcd8e16aefeb54733c880c686107439ba51ec50aa89f0f571b6322998d5fe1d4862d4b8a4e78df003fbe4d1d849ebcbc9
-  data.tar.gz: 6492a8277ff6d0179a5fd91e3758cc0edc5ff73faf584237336395a52d151654a7c451085ddde6e40532010b3e6d5f9046a3f058237c7879b6da184141b63877
+  metadata.gz: dd5056baa29e1b15c5ecad2e570969a21247dec9df18d1f0e18575e4a801c0427b66b20a20a6af44a17889e5b455cc17fb55e042c203e6f154046e648630fa6b
+  data.tar.gz: 07a96a039ff2a06774725ca1187bc7e8c09a938513893c52b8f2d7bf6d467f7febd45529cd7beabe1ed746c7dfc4118a7936677b890681c7840edbfe4c31e8dd

data/lib/epuber/checker/text_checker.rb

@@ -61,8 +61,7 @@ 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.warning MatchProblem.new(match, message, Config.instance.pretty_path_from_project(file_path))
         end
       end
 

data/lib/epuber/checker.rb

@@ -17,16 +17,12 @@ module Epuber
       }.merge(super)
     end
 
-    def warning(messsage, location: nil)
+    def warning(messsage, location: caller_locations.first)
       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
+    def error(messsage, location: caller_locations.first)
+      UI.error(messsage, location: location)
     end
   end
 end

data/lib/epuber/command/build.rb

@@ -40,7 +40,7 @@ module Epuber
         @release_version = argv.flag?('release', false)
         @use_cache = argv.flag?('cache', true)
 
-        self.debug_steps_times = argv.flag?('debug-steps-times', false)
+        UI.logger.debug_steps_times = argv.flag?('debug-steps-times', false)
 
         super(argv)
       end
@@ -56,7 +56,7 @@ module Epuber
       def run
         super
 
-        UI.puts "building book `#{Config.instance.pretty_path_from_project(book.file_path)}`"
+        UI.info "building book `#{Config.instance.pretty_path_from_project(book.file_path)}`"
 
         if @release_version
           # Remove all previous versions of compiled files
@@ -77,9 +77,7 @@ module Epuber
             FileUtils.remove_file(archive_name) if ::File.exist?(archive_name)
 
             archive_path = compiler.archive(archive_name)
-
-            Epubcheck.check(archive_path)
-
+            run_epubcheck(archive_path, build_path)
             convert_epub_to_mobi(archive_path, "#{::File.basename(archive_path, '.epub')}.mobi") if target.create_mobi
 
             Epuber::Config.instance.release_build = false
@@ -94,13 +92,19 @@ module Epuber
                                          use_cache: @use_cache)
             archive_path = compiler.archive(configuration_suffix: 'debug')
 
-            Epubcheck.check(archive_path) if @should_check
+            run_epubcheck(archive_path, build_path) if @should_check
 
             convert_epub_to_mobi(archive_path, "#{::File.basename(archive_path, '.epub')}.mobi") if target.create_mobi
           end
         end
 
-        write_lockfile
+        # Exit with error if there are any errors
+        if (@release_version || @should_check) && Epuber::UI.logger.error?
+          exit(1)
+        else
+          UI.info('🎉 Build finished successfully.'.ansi.green)
+          write_lockfile
+        end
       end
 
       private
@@ -131,6 +135,38 @@ module Epuber
         path
       end
 
+      def run_epubcheck(archive_path, build_dir)
+        UI.info("Running Epubcheck for #{archive_path}")
+
+        report = Epubcheck.check(archive_path)
+        report.problems.each do |problem|
+          relative_path = problem.location.path.sub("#{archive_path}/", '')
+          file_path = ::File.join(build_dir, relative_path)
+
+          nice_path = Config.instance.pretty_path_from_project(file_path)
+          content = ::File.read(file_path)
+
+          log_level = case problem.level
+                      when :fatal, :error then :error
+                      when :warning then :warning
+                      else :info
+                      end
+          message = "#{problem.level}(#{problem.code}): #{problem.message}"
+
+          p = Compiler::Problem.new(problem.level, message, content, line: problem.location.lineno,
+                                                                     column: problem.location.column,
+                                                                     length: 1,
+                                                                     file_path: nice_path)
+          UI.send(log_level, p, backtrace: nil)
+        end
+
+        if report.error?
+          UI.error('Epubcheck found some errors in epub file.')
+        else
+          UI.info('Epubcheck finished successfully.')
+        end
+      end
+
       def find_calibre_app
         locations = `mdfind "kMDItemCFBundleIdentifier == net.kovidgoyal.calibre"`.split("\n")
         UI.error!("Can't find location of calibre.app to convert EPUB to MOBI.") if locations.empty?

data/lib/epuber/command/init.rb

@@ -52,7 +52,7 @@ module Epuber
       private
 
       def print_good_bye(book_id)
-        UI.puts <<~TEXT.ansi.green
+        UI.info <<~TEXT.ansi.green
           Project initialized, please review #{book_id}.bookspec file, remove comments and fill some attributes like book title.
         TEXT
       end
@@ -124,7 +124,7 @@ module Epuber
       #
       def write(file_path, string)
         File.write(file_path, string)
-        UI.puts "   #{'create'.ansi.green}  #{file_path}"
+        UI.info "   #{'create'.ansi.green}  #{file_path}"
       end
 
       # @param [String] string text to file
@@ -148,7 +148,7 @@ module Epuber
         existing_content << "\n"
 
         File.write(file_path, existing_content)
-        UI.puts "   #{'update'.ansi.green}  #{file_path}"
+        UI.info "   #{'update'.ansi.green}  #{file_path}"
       end
 
       # @param [String] dir_path path to dir
@@ -157,7 +157,7 @@ module Epuber
       #
       def create_folder(dir_path)
         FileUtils.mkdir_p(dir_path)
-        UI.puts "   #{'create'.ansi.green}  #{dir_path}/"
+        UI.info "   #{'create'.ansi.green}  #{dir_path}/"
       end
 
       # @param [String] text
@@ -169,7 +169,7 @@ module Epuber
         result = $stdin.gets.chomp
 
         while result.empty?
-          UI.puts 'Value cannot be empty, please fill it!'.ansi.red
+          UI.info 'Value cannot be empty, please fill it!'.ansi.red
           print text
           result = $stdin.gets.chomp
         end

data/lib/epuber/command/server.rb

@@ -51,7 +51,7 @@ module Epuber
               if @open_web_browser
                 system "open #{uri}"
               else
-                UI.puts 'Web browser can be automatically opened by adding --open flag, see --help'
+                UI.info 'Web browser can be automatically opened by adding --open flag, see --help'
               end
             end
           end

data/lib/epuber/command.rb

@@ -25,32 +25,23 @@ module Epuber
     self.plugin_prefixes = plugin_prefixes + %w[epuber]
 
     def self.run(argv = [])
-      UI.current_command = self
       super
-      UI.current_command = nil
     rescue Interrupt
       UI.error('[!] Cancelled')
     rescue StandardError => e
       UI.error!(e)
-
-      UI.current_command = nil
     end
 
-    def validate!
+    def initialize(argv)
       super
-      UI.current_command = self
-    end
 
-    def run
-      UI.current_command = self
+      UI.logger.verbose = verbose?
     end
 
-    attr_reader :debug_steps_times
+    def run; end
 
     protected
 
-    attr_writer :debug_steps_times
-
     # @return [Epuber::Book::Book]
     #
     def book
@@ -62,9 +53,16 @@ module Epuber
     # @raise PlainInformative if no .bookspec file don't exists or there are too many
     #
     def verify_one_bookspec_exists!
-      bookspec_files = Config.instance.find_all_bookspecs
-      raise PlainInformative, "No `.bookspec' found in the project directory." if bookspec_files.empty?
-      raise PlainInformative, "Multiple `.bookspec' found in current directory" if bookspec_files.count > 1
+      project_path = Config.instance.project_path
+      bookspec_files = Config.find_bookspec_files(project_path)
+
+      if bookspec_files.empty?
+        raise PlainInformative, "No `.bookspec' found in the project directory (or in any parent folders)."
+      end
+
+      if bookspec_files.count > 1
+        raise PlainInformative, "Multiple `.bookspec' found in directory (directory: #{project_path})"
+      end
     end
 
     def write_lockfile
@@ -76,10 +74,17 @@ module Epuber
     def pre_build_checks
       Config.instance.warn_for_outdated_versions!
 
-      return unless !Config.instance.same_version_as_last_run? && File.exist?(Config.instance.working_path)
-
-      UI.warning('Using different version of Epuber or Bade, removing all build caches')
-      Config.instance.remove_build_caches
+      # remove build caches if we are using different version of Epuber or Bade
+      if !Config.instance.same_version_as_last_run? && File.exist?(Config.instance.working_path)
+        UI.warning('Using different version of Epuber or Bade, removing all build caches')
+        Config.instance.remove_build_caches
+      end
+
+      # ensure we are in the project directory
+      if Dir.pwd != Config.instance.project_path
+        UI.debug("Changing directory to project directory: #{Config.instance.project_path}")
+        Dir.chdir(Config.instance.project_path)
+      end
     end
   end
 end

data/lib/epuber/compiler/compilation_context.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-
 module Epuber
   class Compiler
     class CompilationContext
@@ -37,13 +36,14 @@ module Epuber
             file_resolver.add_file(file)
           end
           plugin
-        rescue LoadError
-          UI.error "Can't find plugin at path #{path}"
+        rescue LoadError => e
+          UI.error "Can't find plugin at path #{path}, #{e}"
         end.compact
       end
 
       # @param [Class] klass class of thing you want to perform (Checker or Transformer)
       # @param [Symbol] source_type source type of that thing (Checker or Transformer)
+      # @param [String] processing_time_step_name name of step for processing time
       #
       # @yield
       # @yieldparam [Epuber::CheckerTransformerBase] instance of checker or transformer
@@ -58,7 +58,11 @@ module Epuber
             next if instance.source_type != source_type
             next if instance.options.include?(:run_only_before_release) && !release_build
 
-            yield instance
+            location = instance.block.source_location.map(&:to_s).join(':')
+            message = "performing #{source_type.inspect} from plugin #{location}"
+            UI.print_step_processing_time(message) do
+              yield instance
+            end
           end
         end
       end

data/lib/epuber/compiler/file_resolver.rb

@@ -27,7 +27,7 @@ module Epuber
 
       PATH_TYPES = [:spine, :manifest, :package, nil].freeze
 
-      # @return [String] path where should look for source files
+      # @return [String] path where should look for source files (relative to project root)
       #
       attr_reader :source_path
 

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

@@ -6,7 +6,7 @@ module Epuber
       require_relative 'abstract_file'
 
       class SourceFile < AbstractFile
-        # @return [String] relative source path
+        # @return [String] relative source path (from project root)
         #
         attr_reader :source_path
 
@@ -133,7 +133,7 @@ module Epuber
             rescue XHTMLProcessor::UnparseableLinkError,
                    FileFinders::FileNotFoundError,
                    FileFinders::MultipleFilesFoundError => e
-              UI.warning(e.to_s, location: location)
+              UI.error(e.to_s, location: location)
               return nil
             end
           end

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

@@ -142,18 +142,14 @@ module Epuber
           end
 
           # perform transformations
-          UI.print_step_processing_time('performing final transformations') do
-            compilation_context.perform_plugin_things(Transformer, :result_text_xhtml_string) do |transformer|
-              xhtml_string = transformer.call(final_destination_path, xhtml_string, compilation_context)
-            end
+          compilation_context.perform_plugin_things(Transformer, :result_text_xhtml_string) do |transformer|
+            xhtml_string = transformer.call(final_destination_path, xhtml_string, compilation_context)
           end
 
           # perform custom validation
           if compilation_context.should_check
-            UI.print_step_processing_time('performing final validations') do
-              compilation_context.perform_plugin_things(Checker, :result_text_xhtml_string) do |checker|
-                checker.call(final_destination_path, xhtml_string, compilation_context)
-              end
+            compilation_context.perform_plugin_things(Checker, :result_text_xhtml_string) do |checker|
+              checker.call(final_destination_path, xhtml_string, compilation_context)
             end
           end
 
@@ -175,7 +171,7 @@ module Epuber
         # @param [Compiler::CompilationContext] compilation_context
         # @param [Hash<String, XHTMLFile>] global_ids
         #
-        def process_global_ids(compilation_context, global_ids)
+        def process_global_ids(_compilation_context, global_ids)
           return if self.global_ids.empty? && global_links.empty?
 
           xhtml_doc = XHTMLProcessor.xml_document_from_string(File.read(final_destination_path), final_destination_path)
@@ -196,12 +192,8 @@ module Epuber
               node['href'] = "#{rel_path}##{href}"
             else
               message = "Can't find global id '#{href}' from link in file #{source_path}"
-              location = UserInterface::Location.new(path: final_destination_path, lineno: node.line)
-              if compilation_context.release_build?
-                UI.error!(message, location: location)
-              else
-                UI.warning(message, location: location)
-              end
+              location = Epuber::Location.new(path: final_destination_path, lineno: node.line)
+              UI.error(message, location: location)
             end
           end
 

data/lib/epuber/compiler/xhtml_processor.rb

@@ -25,7 +25,7 @@ module Epuber
 
         if /\A[\n\r ]+(<\?xml)/ =~ text
           UI.warning('XML header must be at the beginning of document',
-                     location: UI::Location.new(path: file_path, lineno: 1))
+                     location: Epuber::Location.new(path: file_path, lineno: 1))
 
           text = text.lstrip
         end
@@ -198,7 +198,7 @@ module Epuber
       # @param [Symbol | Array<Symbol>] groups  groups of the searching file, could be for example :image when searching
       #                                         for file from tag <img>
       # @param [String] file_path  path to file from which is searching for other file
-      # @param [Epuber::Compiler::FileFinder] file_finder  finder for searching for files
+      # @param [Epuber::Compiler::FileFinders::Abstract] file_finder  finder for searching for files
       #
       # @raise UnparseableLinkError, FileFinder::FileNotFoundError, FileFinder::MultipleFilesFoundError
       #

data/lib/epuber/compiler.rb

@@ -71,7 +71,7 @@ module Epuber
 
         FileUtils.mkdir_p(build_folder)
 
-        UI.puts "  #{<<~MSG}"
+        UI.info "  #{<<~MSG}"
           building target #{@target.name.inspect} (build dir: #{Config.instance.pretty_path_from_project(build_folder)})
         MSG
 
@@ -89,6 +89,7 @@ module Epuber
         process_all_target_files
         generate_other_files
 
+        # run :after_all_text_files transformers
         compilation_context.perform_plugin_things(Transformer, :after_all_text_files) do |transformer|
           transformer.call(@book, compilation_context)
         end
@@ -131,7 +132,7 @@ module Epuber
             old_paths = zip_file.instance_eval { @entry_set.entries.map(&:name) }
             diff = old_paths - new_paths
             diff.each do |file_to_remove|
-              UI.puts "DEBUG: removing file from result EPUB: #{file_to_remove}" if compilation_context.verbose?
+              UI.debug "removing file from result EPUB: #{file_to_remove}"
               zip_file.remove(file_to_remove)
             end
           end
@@ -174,7 +175,7 @@ module Epuber
            .select { |d| File.directory?(d) }
            .select { |d| (Dir.entries(d) - %w[. ..]).empty? }
            .each do |d|
-             UI.puts "DEBUG: removing empty folder `#{d}`" if compilation_context.verbose?
+             UI.debug "removing empty folder `#{d}`"
              Dir.rmdir(d)
            end
       end
@@ -188,7 +189,7 @@ module Epuber
       end
       unnecessary_paths.each do |path|
         if compilation_context.verbose?
-          UI.puts "DEBUG: removing unnecessary file: `#{Config.instance.pretty_path_from_project(path)}`"
+          UI.debug "removing unnecessary file: `#{Config.instance.pretty_path_from_project(path)}`"
         end
 
         File.delete(path)
@@ -283,11 +284,11 @@ module Epuber
     #
     def process_all_target_files
       @file_resolver.manifest_files.each_with_index do |file, idx|
-        UI.print_processing_file(file, idx, @file_resolver.manifest_files.count)
+        UI.start_processing_file(file, idx, @file_resolver.manifest_files.count)
         process_file(file)
       end
 
-      UI.processing_files_done
+      UI.end_processing
     end
 
     # @param [Epuber::Book::TocItem] toc_item
@@ -305,11 +306,13 @@ module Epuber
     end
 
     def process_global_ids
-      xhtml_files = @file_resolver.files.select { |file| file.is_a?(FileTypes::XHTMLFile) }
-      global_ids = validate_global_ids(xhtml_files)
+      UI.print_step_processing_time('Processing global ids') do
+        xhtml_files = @file_resolver.files.select { |file| file.is_a?(FileTypes::XHTMLFile) }
+        global_ids = validate_global_ids(xhtml_files)
 
-      xhtml_files.each do |file|
-        file.process_global_ids(compilation_context, global_ids)
+        xhtml_files.each do |file|
+          file.process_global_ids(compilation_context, global_ids)
+        end
       end
     end
 

data/lib/epuber/config.rb

@@ -8,10 +8,13 @@ module Epuber
   class Config
     WORKING_PATH = '.epuber'
 
-    # @return [String]
+    # @return [String] path to project directory (where .bookspec file is located or current directory if not found)
     #
     def project_path
-      @project_path ||= Dir.pwd.unicode_normalize
+      @project_path ||= begin
+        path = self.class.find_project_dir(Dir.pwd) || Dir.pwd
+        path.unicode_normalize
+      end
     end
 
     # @param [String] of_file absolute path to file
@@ -19,7 +22,9 @@ module Epuber
     # @return [String] relative path to file from root of project
     #
     def pretty_path_from_project(of_file)
-      Pathname.new(of_file.unicode_normalize).relative_path_from(Pathname.new(project_path)).to_s
+      Pathname.new(of_file.unicode_normalize)
+              .relative_path_from(Pathname.new(project_path))
+              .to_s
     end
 
     # @return [String]
@@ -31,7 +36,7 @@ module Epuber
     # @return [String]
     #
     def bookspec_path
-      @bookspec_path ||= find_all_bookspecs.first
+      @bookspec_path ||= self.class.find_bookspec_files(project_path).first
     end
 
     # @return [String]
@@ -40,16 +45,6 @@ module Epuber
       "#{bookspec_path}.lock"
     end
 
-    # @return [Array<String>]
-    #
-    def find_all_bookspecs
-      Dir.chdir(project_path) do
-        Dir.glob('*.bookspec').map do |path|
-          File.expand_path(path)
-        end
-      end
-    end
-
     # @return [Epuber::Book]
     #
     def bookspec
@@ -182,6 +177,32 @@ module Epuber
 
         book
       end
+
+      # Find all bookspec files in given directory
+      #
+      # @param [String] dir
+      #
+      def find_bookspec_files(dir)
+        Dir.chdir(dir) do
+          Dir.glob('*.bookspec').map do |path|
+            File.expand_path(path)
+          end
+        end
+      end
+
+      # Find project directory by searching for .bookspec files in current and parent directories
+      #
+      # @param [String] dir
+      # @return [String, nil]
+      #
+      def find_project_dir(dir)
+        return dir if find_bookspec_files(dir).any?
+
+        parent = File.dirname(dir)
+        return nil if parent == dir
+
+        find_project_dir(parent)
+      end
     end
 
     self.test = false

data/lib/epuber/epubcheck.rb

@@ -1,14 +1,94 @@
 # frozen_string_literal: true
 
+require 'open3'
+require 'json'
+
+require_relative 'utils/location'
+
 module Epuber
   class Epubcheck
+    Report = Struct.new(:problems, keyword_init: true) do
+      # !attribute [r] problems
+      #   @return [Array<Problem>] problems found by epubcheck
+
+      def error?
+        problems.any?(&:error?)
+      end
+    end
+
+    Problem = Struct.new(:level, :code, :location, :message, keyword_init: true) do
+      # !attribute [r] level
+      #   @return [Symbol] level of the problem (:fatal, :error, :warning, :info, :usage, :suppressed)
+
+      # !attribute [r] code
+      #   @return [String] code of the problem (for example: RSC-005)
+
+      # !attribute [r] location
+      #   @return [Epuber::Location, nil] location of the problem
+
+      # !attribute [r] message
+      #   @return [String] message of the problem
+
+      def to_s
+        "#{level}(#{code}): #{location.path}(#{location.lineno},#{location.column}): #{message}"
+      end
+
+      def error?
+        level == :error || level == :fatal
+      end
+
+      def self.from_json(json)
+        json_location = json['locations'].first
+
+        location = if json_location
+                     Epuber::Location.new(
+                       path: json_location['path'],
+                       lineno: json_location['line'],
+                       column: json_location['column'],
+                     )
+                   end
+
+        new(
+          level: json['severity'].downcase.to_sym,
+          code: json['ID'],
+          message: json['message'],
+          location: location,
+        )
+      end
+    end
+
     class << self
       # @param [String] path path to file
       #
+      # @return [Report] report of the epubcheck
+      #
       def check(path)
-        res = system('epubcheck', path)
+        report = nil
+
+        Dir.mktmpdir('epubcheck-') do |tmpdir|
+          json_path = File.join(tmpdir, 'epubcheck.json')
+          Open3.popen3('epubcheck', path, '--json', json_path) do |_stdin, _stdout, stderr, wait_thr|
+            exit_status = wait_thr.value
+
+            if exit_status.success?
+              report = _parse_json(File.read(json_path))
+            else
+              UI.error(stderr.gets.chomp)
+            end
+          end
+        end
+
+        report
+      end
+
+      # @param [String] string json string
+      # @return [Report]
+      #
+      def _parse_json(string)
+        json = JSON.parse(string)
+        messages = json['messages']
 
-        UI.error!('Epubcheck failed') unless res
+        Report.new(problems: messages.map { |msg| Problem.from_json(msg) })
       end
     end
   end