spectre-core 1.12.2 → 1.13.0

data/lib/spectre/logger/file.rb

@@ -1,5 +1,5 @@
 module Spectre
-  module Logger
+  module Logging
     class File
       def initialize config
         raise 'No log format section in config for console logger' unless config.key? 'log_format' and config['log_format'].key? 'file'
@@ -9,87 +9,93 @@ module Spectre
         @fmt_end_group = @config['end_group']
         @fmt_sep = @config['separator']
 
-        @file_log = ::Logger.new config['log_file'], progname: 'spectre'
+        @file_log = ::Logger.new(config['log_file'], progname: 'spectre')
         @file_log.level = config['debug'] ? 'DEBUG' : 'INFO'
       end
 
       def start_subject subject
-        @file_log.debug "start running subject '#{subject.desc}'"
+        @file_log.debug("start running subject '#{subject.desc}'")
       end
 
       def end_subject subject
-        @file_log.debug "subject '#{subject.desc}' finished"
+        @file_log.debug("subject '#{subject.desc}' finished")
       end
 
       def start_context context
         if context and context.__desc
-          @file_log.debug "start running context '#{context.__desc}'"
+          @file_log.debug("start running context '#{context.__desc}'")
         else
-          @file_log.debug "start running main context of #{context.__subject.desc}"
+          @file_log.debug("start running main context of #{context.__subject.desc}")
         end
       end
 
       def end_context context
         if context and context.__desc
-          @file_log.debug "context '#{context.__desc}' finished"
+          @file_log.debug("context '#{context.__desc}' finished")
         else
-          @file_log.debug "main context finished of #{context.__subject.desc}"
+          @file_log.debug("main context finished of #{context.__subject.desc}")
         end
       end
 
       def start_spec spec, data=nil
         log_msg = "start running spec [#{spec.name}] '#{spec.desc}'"
         log_msg += " with data #{data}" if data
-        @file_log.debug log_msg
+        @file_log.debug(log_msg)
       end
 
       def end_spec spec, data=nil
         log_msg = "running spec [#{spec.name}] '#{spec.desc}'"
         log_msg += " with data #{data}" if data
         log_msg += " finished"
-        @file_log.debug log_msg
+        @file_log.debug(log_msg)
       end
 
       def log_separator desc
         desc = @fmt_sep.gsub('<desc>', desc) if @fmt_sep
-        @file_log.info desc
+        @file_log.info(desc)
       end
 
       def start_group desc
         desc = @fmt_start_group.gsub('<desc>', desc) if @fmt_start_group
-        @file_log.info desc
+        @file_log.info(desc)
       end
 
       def end_group desc
         desc = @fmt_end_group.gsub('<desc>', desc) if @fmt_end_group
-        @file_log.info desc
+        @file_log.info(desc)
       end
 
       def log_process desc
-        @file_log.debug desc
+        @file_log.debug(desc)
       end
 
       def log_info message
-        @file_log.info "#{Status::INFO} #{message}"
+        @file_log.info("#{Status::INFO} #{message}")
       end
 
       def log_debug message
-        @file_log.debug "#{Status::DEBUG} #{message}"
+        @file_log.debug("#{Status::DEBUG} #{message}")
       end
 
       def log_error spec, exception
         file, line = exception.backtrace[0].match(/(.*\.rb):(\d+)/).captures
-        @file_log.error "An unexpected error occured at '#{file}:#{line}' while running spec '#{spec.name}': [#{exception.class}] #{exception.message}\n#{exception.backtrace.join "\n"}"
+        @file_log.error("An unexpected error occurred at '#{file}:#{line}' while running spec '#{spec.name}': [#{exception.class}] #{exception.message}\n#{exception.backtrace.join "\n"}")
       end
 
-      def log_skipped spec
-        @file_log.warn "spec '#{spec.desc}' canceled by user"
+      def log_skipped spec, message=nil
+        txt = "spec '#{spec.desc}' skipped"
+
+        unless message.nil?
+          txt += ': ' + message
+        end
+
+        @file_log.warn(txt)
       end
 
       def log_status desc, status, annotation=nil
         msg = "expected #{desc}...#{status.upcase}"
         msg += " - #{annotation}" if annotation
-        @file_log.debug msg
+        @file_log.debug(msg)
       end
     end
   end

data/lib/spectre/logger.rb

@@ -2,7 +2,7 @@ require_relative '../spectre'
 require 'date'
 
 module Spectre
-  module Logger
+  module Logging
     module Status
       OK = '[ok]'
       FAILED = '[failed]'
@@ -12,6 +12,31 @@ module Spectre
       DEBUG = '[debug]'
     end
 
+    class ModuleLogger
+      def initialize config, name
+        @name = name
+        @debug = config['debug']
+        @logger = ::Logger.new(config['log_file'], progname: name)
+
+        @logger.level = @debug ? ::Logger::DEBUG : ::Logger::INFO
+      end
+
+      def info message
+        @logger.info(message)
+        Logging.add_log(message, :info, @name)
+      end
+
+      def debug message
+        @logger.debug(message)
+        Logging.add_log(message, :debug, @name) if @debug
+      end
+
+      def warn message
+        @logger.warn(message)
+        Logging.add_log(message, :warn, @name)
+      end
+    end
+
     class << self
       @@debug = false
       @@logger = []
@@ -93,24 +118,24 @@ module Spectre
       end
 
       def log_info message
-        add_log(message)
+        add_log(message, :info)
         delegate(:log_info, message)
       end
 
       def log_debug message
         return unless @@debug
 
-        add_log(message)
+        add_log(message, :debug)
         delegate(:log_debug, message)
       end
 
       def log_error spec, exception
-        add_log(exception)
+        add_log(exception, :error)
         delegate(:log_error, spec, exception)
       end
 
-      def log_skipped spec
-        delegate(:log_skipped, spec)
+      def log_skipped spec, message=nil
+        delegate(:log_skipped, spec, message)
       end
 
       def log_status desc, status, annotation=nil
@@ -118,9 +143,15 @@ module Spectre
       end
 
       def group desc
-        Logger.start_group desc
+        Logging.start_group desc
         yield
-        Logger.end_group desc
+        Logging.end_group desc
+      end
+
+      def add_log message, level, logger_name='spectre'
+        return unless Spectre::Runner.current
+
+        Spectre::Runner.current.log.append([DateTime.now, message, level, logger_name])
       end
 
       alias_method :info, :log_info
@@ -135,10 +166,6 @@ module Spectre
           logger.send(method, *args) if logger.respond_to? method
         end
       end
-
-      def add_log message
-        Spectre::Runner.current.log.append([DateTime.now, message])
-      end
     end
 
     Spectre.delegate :log, :info, :debug, :group, :separate, to: self

data/lib/spectre/mixin.rb

@@ -12,12 +12,12 @@ module Spectre
 
       def required params, *keys
         missing_keys = keys.select { |x| !params.to_h.key? x }
-        Spectre::Logger.log_debug("required parameters for '#{@__desc}': #{keys.join ', '}")
+        Spectre::Logging.log_debug("required parameters for '#{@__desc}': #{keys.join ', '}")
         raise ArgumentError, "mixin '#{@__desc}' requires #{keys.join ', '}, but only has #{missing_keys.join ', '} given" unless missing_keys.empty?
       end
 
       def optional params, *keys
-        Spectre::Logger.log_debug("optional parameters for '#{@__desc}': #{keys.join ', '}")
+        Spectre::Logging.log_debug("optional parameters for '#{@__desc}': #{keys.join ', '}")
         params
       end
     end
@@ -32,7 +32,7 @@ module Spectre
       def run desc, with: []
         raise "no mixin with desc '#{desc}' defined" unless @@mixins.key? desc
 
-        Spectre::Logger.log_debug "running mixin '#{desc}'"
+        Spectre::Logging.log_debug "running mixin '#{desc}'"
 
         params = with || {}
 

data/lib/spectre/reporter/console.rb

@@ -14,37 +14,34 @@ module Spectre::Reporter
       run_infos
         .select { |x| x.error != nil or x.failure != nil }
         .each_with_index do |run_info, index|
-        spec = run_info.spec
+          report_str += "\n#{index+1}) #{format_title(run_info)}\n"
 
-        report_str += "\n#{index+1}) #{format_title(run_info)}\n"
+          if run_info.failure
+            report_str += "     Expected #{run_info.failure.expectation}"
+            report_str += " with #{run_info.data}" if run_info.data
 
-        if run_info.failure
-          report_str += "     Expected #{run_info.failure.expectation}"
-          report_str += " with #{run_info.data}" if run_info.data
-          report_str += " during #{spec.context.__desc}" if spec.context.__desc
+            report_str += " but it failed"
 
-          report_str += " but it failed"
+            if run_info.failure.cause
+              report_str += "\n     with an unexpected error:\n"
+              report_str += format_exception(run_info.failure.cause)
 
-          if run_info.failure.cause
-            report_str += "\n     with an unexpected error:\n"
-            report_str += format_exception(run_info.failure.cause)
+            elsif run_info.failure.message and not run_info.failure.message.empty?
+              report_str += " with:\n     #{run_info.failure.message}"
 
-          elsif run_info.failure.message and not run_info.failure.message.empty?
-            report_str += " with:\n     #{run_info.failure.message}"
+            else
+              report_str += '.'
+            end
+
+            report_str += "\n"
+            failures += 1
 
           else
-            report_str += '.'
+            report_str += "     but an unexpected error occurred during run\n"
+            report_str += format_exception(run_info.error)
+            errors += 1
           end
-
-          report_str += "\n"
-          failures += 1
-
-        else
-          report_str += "     but an unexpected error occured during run\n"
-          report_str += format_exception(run_info.error)
-          errors += 1
         end
-      end
 
       if failures + errors > 0
         summary = ''
@@ -55,7 +52,6 @@ module Spectre::Reporter
         summary += "#{run_infos.length} total"
         print "\n#{summary}\n".red
       else
-        summary = ''
         summary = "\nRun finished successfully"
         summary += " (#{skipped} skipped)" if skipped > 0
         print "#{summary}\n".green
@@ -68,6 +64,7 @@ module Spectre::Reporter
 
     def format_title run_info
       title = run_info.spec.subject.desc
+      title += " #{run_info.spec.context.__desc}" if run_info.spec.context.__desc
       title += ' ' + run_info.spec.desc
       title += " (#{'%.3f' % run_info.duration}s)"
       title += " [#{run_info.spec.name}]"