epuber 0.9.4 → 0.10.0

data/lib/epuber/utils/logger/console_logger.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require_relative 'abstract_logger'
+
+module Epuber
+  module Logger
+    class ConsoleLogger < AbstractLogger
+      def _log(level, message, location: nil, backtrace: nil, sticky: false)
+        prev_line = _remove_sticky_message
+
+        # save sticky message
+        @sticky_message = message if sticky
+
+        formatted_message = _format_message(level, message, location: location, backtrace: backtrace)
+
+        # print the message
+        if sticky
+          $stdout.print(formatted_message)
+        else
+          $stdout.puts(formatted_message)
+
+          # reprint previous sticky message when this message is not sticky
+          if prev_line
+            @sticky_message = prev_line
+            $stdout.print(prev_line)
+          end
+        end
+      end
+
+      private
+
+      # @param [Symbol] level color of the output
+      #
+      # @return [Symbol] color
+      #
+      def _color_from_level(level)
+        case level
+        when :error then   :red
+        when :warning then :yellow
+        when :info then    :white
+        when :debug then   :blue
+        else
+          raise "Unknown output level #{level}"
+        end
+      end
+
+      # @param [Symbol] level color of the output
+      # @param [String] message message of the error
+      # @param [Thread::Backtrace::Location] location location of the error
+      #
+      # @return [String] formatted message
+      #
+      def _format_message(level, message, location: nil, backtrace: nil)
+        location = _location_from_obj(location)
+
+        comps = []
+        comps << message.to_s
+        message_already_formatted =
+          message.is_a?(Epuber::Compiler::Problem) || message.is_a?(Epuber::Checker::TextChecker::MatchProblem)
+
+        should_add_location = if message_already_formatted || location.nil?
+                                false
+                              else
+                                %i[error warning].include?(level)
+                              end
+
+        # add location
+        if should_add_location
+          path = location.path
+
+          # calculate relative path when path is absolute and in project
+          path = path[Config.instance.project_path.size + 1..-1] if path.start_with?(Config.instance.project_path)
+
+          line_parts = [
+            "  (in file #{path}",
+          ]
+          line_parts << "line #{location.lineno}" if location.lineno
+          line_parts << "column #{location.column}" if location.column
+
+          comps << "#{line_parts.join(' ')})"
+        end
+
+        # add backtrace
+        comps += _format_backtrace(backtrace, location: location) if backtrace && @verbose && level == :error
+
+        comps.join("\n").ansi.send(_color_from_level(level))
+      end
+
+      # @param [Array<Thread::Backtrace::Location>] locations locations of the error (only for verbose output)
+      # @param [Thread::Backtrace::Location] location location of the error
+      #
+      # @return [Array<String>] formatted message
+      #
+      def _format_backtrace(locations, location: nil)
+        index = locations.index(location) || 0
+
+        formatted = []
+        formatted << '' # empty line
+        formatted << 'Full backtrace:'
+        formatted += locations[index, locations.size].map do |loc|
+          "  #{loc}"
+        end
+
+        formatted
+      end
+
+      # @return [String, nil] last line
+      #
+      def _remove_sticky_message
+        last_line = @sticky_message
+
+        unless @sticky_message.nil?
+          $stdout.print("\033[2K") # remove line, but without moving cursor
+          $stdout.print("\r") # go to beginning of line
+          @sticky_message = nil
+        end
+
+        last_line
+      end
+    end
+  end
+end

data/lib/epuber/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Epuber
-  VERSION = '0.9.4'
+  VERSION = '0.10.0'
 
   HOME_URL = 'https://github.com/epuber-io/epuber'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epuber
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Roman Kříž
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -568,6 +568,9 @@ files:
 - lib/epuber/transformer/book_transformer.rb
 - lib/epuber/transformer/text_transformer.rb
 - lib/epuber/user_interface.rb
+- lib/epuber/utils/location.rb
+- lib/epuber/utils/logger/abstract_logger.rb
+- lib/epuber/utils/logger/console_logger.rb
 - lib/epuber/vendor/hash_binding.rb
 - lib/epuber/vendor/nokogiri_extensions.rb
 - lib/epuber/vendor/ruby_templater.rb