mutant 0.8.0 → 0.8.1

data/lib/mutant/parallel/source.rb

@@ -6,7 +6,7 @@ module Mutant
 
       NoJobError = Class.new(RuntimeError)
 
-      # Return next job
+      # Next job
       #
       # @return [Object]
       #
@@ -14,7 +14,6 @@ module Mutant
       #   when no next job is available
       #
       # @api private
-      #
       abstract_method :next
 
       # Test if next job is available
@@ -22,7 +21,6 @@ module Mutant
       # @return [Boolean]
       #
       # @api private
-      #
       abstract_method :next?
 
       # Job source backed by a finite array
@@ -34,7 +32,6 @@ module Mutant
         # @return [undefined]
         #
         # @api private
-        #
         def initialize(*)
           super
 
@@ -46,12 +43,11 @@ module Mutant
         # @return [Boolean]
         #
         # @api private
-        #
         def next?
           @next_index < jobs.length
         end
 
-        # Return next job
+        # Next job
         #
         # @return [Object]
         #
@@ -59,7 +55,6 @@ module Mutant
         #   when no next job is available
         #
         # @api private
-        #
         def next
           fail NoJobError unless next?
           jobs.fetch(@next_index).tap do

data/lib/mutant/parallel/worker.rb

@@ -11,7 +11,6 @@ module Mutant
       # @return [self]
       #
       # @api private
-      #
       def self.run(attributes)
         new(attributes).run
         self
@@ -23,10 +22,9 @@ module Mutant
       #
       # @return [self]
       #
-      # @api private
-      #
       # rubocop:disable Lint/Loop
       #
+      # @api private
       def run
         begin
           parent.call(Actor::Message.new(:ready, mailbox.sender))
@@ -42,7 +40,6 @@ module Mutant
       # @return [Boolean]
       #
       # @api private
-      #
       def handle(message)
         type, payload = message.type, message.payload
         case message.type
@@ -63,7 +60,6 @@ module Mutant
       # @return [undefined]
       #
       # @api private
-      #
       def handle_job(job)
         result = processor.call(job.payload)
         parent.call(Actor::Message.new(:result, JobResult.new(job: job, payload: result)))

data/lib/mutant/reporter.rb

@@ -10,7 +10,6 @@ module Mutant
     # @return [self]
     #
     # @api private
-    #
     abstract_method :warn
 
     # Report start
@@ -20,7 +19,6 @@ module Mutant
     # @return [self]
     #
     # @api private
-    #
     abstract_method :start
 
     # Report collector state
@@ -30,7 +28,6 @@ module Mutant
     # @return [self]
     #
     # @api private
-    #
     abstract_method :report
 
     # Report progress on object
@@ -40,7 +37,6 @@ module Mutant
     # @return [self]
     #
     # @api private
-    #
     abstract_method :progress
 
   end # Reporter

data/lib/mutant/reporter/cli.rb

@@ -11,7 +11,6 @@ module Mutant
       # @return [Reporter::CLI]
       #
       # @api private
-      #
       def self.build(output)
         tput = Tput.detect
         tty = output.respond_to?(:tty?) && output.tty?
@@ -30,7 +29,6 @@ module Mutant
       # @return [self]
       #
       # @api private
-      #
       def start(env)
         write(format.start(env))
         self
@@ -43,20 +41,18 @@ module Mutant
       # @return [self]
       #
       # @api private
-      #
       def progress(status)
         write(format.progress(status))
         self
       end
 
-      # Return report delay in seconds
+      # Report delay in seconds
       #
       # TODO: Move this to a callback registration
       #
       # @return [Float]
       #
       # @api private
-      #
       def delay
         format.delay
       end
@@ -68,7 +64,6 @@ module Mutant
       # @return [self]
       #
       # @api private
-      #
       def warn(message)
         output.puts(message)
         self
@@ -81,7 +76,6 @@ module Mutant
       # @return [self]
       #
       # @api private
-      #
       def report(env)
         Printer::EnvResult.call(output, env)
         self
@@ -96,7 +90,6 @@ module Mutant
       # @return [undefined]
       #
       # @api private
-      #
       def write(frame)
         output.write(frame)
       end

data/lib/mutant/reporter/cli/format.rb

@@ -5,32 +5,29 @@ module Mutant
       class Format
         include AbstractType, Anima.new(:tty)
 
-        # Return start representation
+        # Start representation
         #
         # @param [Env] env
         #
         # @return [String]
         #
         # @api private
-        #
         abstract_method :start
 
-        # Return progress representation
+        # Progress representation
         #
         # @param [Runner::Status] status
         #
         # @return [String]
         #
         # @api private
-        #
         abstract_method :progress
 
-        # Return report delay in seconds
+        # Report delay in seconds
         #
         # @return [Float]
         #
         # @api private
-        #
         def delay
           self.class::REPORT_DELAY
         end
@@ -44,7 +41,6 @@ module Mutant
           # @return [Boolean]
           #
           # @api private
-          #
           def tty?
             @tty
           end
@@ -66,7 +62,6 @@ module Mutant
         # @return [String]
         #
         # @api private
-        #
         def format(printer, object)
           buffer = new_buffer
           printer.call(Output.new(tty, buffer), object)
@@ -80,34 +75,31 @@ module Mutant
           REPORT_FREQUENCY = 1.0
           REPORT_DELAY     = 1 / REPORT_FREQUENCY
 
-          # Return start representation
+          # Start representation
           #
           # @return [String]
           #
           # @api private
-          #
           def start(env)
             format(Printer::Config, env.config)
           end
 
-          # Return progress representation
+          # Progress representation
           #
           # @return [String]
           #
           # @api private
-          #
           def progress(status)
             format(Printer::StatusProgressive, status)
           end
 
         private
 
-          # Return new buffer
+          # New buffer
           #
           # @return [StringIO]
           #
           # @api private
-          #
           def new_buffer
             StringIO.new
           end
@@ -130,7 +122,6 @@ module Mutant
           # @return [String]
           #
           # @api private
-          #
           def start(_env)
             tput.prepare
           end
@@ -142,19 +133,17 @@ module Mutant
           # @return [String]
           #
           # @api private
-          #
           def progress(status)
             format(Printer::Status, status)
           end
 
         private
 
-          # Return new buffer
+          # New buffer
           #
           # @return [StringIO]
           #
           # @api private
-          #
           def new_buffer
             # For some reason this raises an Ernno::EACCESS errror:
             #

data/lib/mutant/reporter/cli/printer.rb

@@ -16,17 +16,15 @@ module Mutant
         # @return [self]
         #
         # @api private
-        #
         abstract_method :run
 
       private
 
-        # Return status color
+        # Status color
         #
         # @return [Color]
         #
         # @api private
-        #
         def status_color
           success? ? Color::GREEN : Color::RED
         end
@@ -39,7 +37,6 @@ module Mutant
         # @return [undefined]
         #
         # @api private
-        #
         def visit_collection(printer, collection)
           collection.each do |object|
             visit(printer, object)
@@ -54,7 +51,6 @@ module Mutant
         # @return [undefined]
         #
         # @api private
-        #
         def visit(printer, object)
           printer.call(output, object)
         end
@@ -64,7 +60,6 @@ module Mutant
         # @return [undefined]
         #
         # @api private
-        #
         def info(string, *arguments)
           puts(format(string, *arguments))
         end
@@ -74,7 +69,6 @@ module Mutant
         # @return [undefined]
         #
         # @api private
-        #
         def status(string, *arguments)
           puts(colorize(status_color, format(string, *arguments)))
         end
@@ -84,7 +78,6 @@ module Mutant
         # @return [undefined]
         #
         # @api private
-        #
         def puts(string)
           output.puts(string)
         end
@@ -94,12 +87,11 @@ module Mutant
         # @param [Color] color
         # @param [String] message
         #
-        # @api private
-        #
         # @return [String]
         #   if color is enabled
         #   unmodified message otherwise
         #
+        # @api private
         def colorize(color, message)
           color = Color::NONE unless tty?
           color.format(message)
@@ -110,7 +102,6 @@ module Mutant
         # @return [Boolean]
         #
         # @api private
-        #
         def tty?
           output.tty?
         end
@@ -120,7 +111,6 @@ module Mutant
         # @return [Boolean]
         #
         # @api private
-        #
         alias_method :color?, :tty?
       end # Printer
     end # CLI

data/lib/mutant/reporter/cli/printer/config.rb

@@ -12,13 +12,10 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
-          # rubocop:disable AbcSize
-          #
           def run
             info 'Mutant configuration:'
             info 'Matcher:         %s',      object.matcher.inspect
-            info 'Integration:     %s',      object.integration.name
+            info 'Integration:     %s',      object.integration
             info 'Expect Coverage: %0.2f%%', (object.expected_coverage * 100)
             info 'Jobs:            %d',      object.jobs
             info 'Includes:        %s',      object.includes

data/lib/mutant/reporter/cli/printer/env_progress.rb

@@ -20,11 +20,9 @@ module Mutant
           #
           # @return [undefined]
           #
-          # @api private
-          #
-          # rubocop:disable MethodLength
           # rubocop:disable AbcSize
           #
+          # @api private
           def run
             visit(Config, env.config)
             info 'Subjects:        %s',        amount_subjects
@@ -40,22 +38,20 @@ module Mutant
 
         private
 
-          # Return coverage percent
+          # Coverage in percent
           #
           # @return [Float]
           #
           # @api private
-          #
           def coverage_percent
             coverage * 100
           end
 
-          # Return overhead percent
+          # Overhead in percent
           #
           # @return [Float]
           #
           # @api private
-          #
           def overhead_percent
             (overhead / killtime) * 100
           end

data/lib/mutant/reporter/cli/printer/env_result.rb

@@ -11,7 +11,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def run
             visit_collection(SubjectResult, failed_subject_results)
             visit(EnvProgress, object)

data/lib/mutant/reporter/cli/printer/mutation_progress_result.rb

@@ -12,7 +12,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def run
             char(success? ? SUCCESS : FAILURE)
           end
@@ -26,7 +25,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def char(char)
             output.write(colorize(status_color, char))
           end