mutant 0.8.0 → 0.8.1

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

@@ -51,7 +51,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def run
             puts(mutation.identification)
             print_details
@@ -60,22 +59,20 @@ module Mutant
 
         private
 
-          # Return details
+          # Print mutation details
           #
           # @return [undefined]
           #
           # @api private
-          #
           def print_details
             __send__(MAP.fetch(mutation.class))
           end
 
-          # Return evil details
+          # Evil mutation details
           #
           # @return [String]
           #
           # @api private
-          #
           def evil_details
             diff = Diff.build(mutation.original_source, mutation.source)
             diff = color? ? diff.colorized_diff : diff.diff
@@ -91,7 +88,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def print_no_diff_message
             info(
               NO_DIFF_MESSAGE,
@@ -107,7 +103,6 @@ module Mutant
           # @return [String]
           #
           # @api private
-          #
           def noop_details
             info(NOOP_MESSAGE)
             visit_test_result
@@ -118,7 +113,6 @@ module Mutant
           # @return [String]
           #
           # @api private
-          #
           def neutral_details
             info(NEUTRAL_MESSAGE, original_node.inspect, mutation.source)
             visit_test_result
@@ -129,17 +123,15 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def visit_test_result
             visit(TestResult, test_result)
           end
 
-          # Return original node
+          # Original node
           #
           # @return [Parser::AST::Node]
           #
           # @api private
-          #
           def original_node
             mutation.subject.node
           end

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

@@ -15,7 +15,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def run
             visit(EnvProgress, payload)
             job_status
@@ -30,7 +29,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def job_status
             return if active_jobs.empty?
             info(ACTIVE_JOB_HEADER)
@@ -39,12 +37,11 @@ module Mutant
             end
           end
 
-          # Return active subject results
+          # Active subject results
           #
           # @return [Array<Result::Subject>]
           #
           # @api private
-          #
           def active_subject_results
             active_subjects = active_jobs.map(&:payload).flat_map(&:subject)
 

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

@@ -21,7 +21,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def run
             status(
               FORMAT,
@@ -36,12 +35,11 @@ module Mutant
 
         private
 
-          # Return object being printed
+          # Object being printed
           #
           # @return [Result::Env]
           #
           # @api private
-          #
           def object
             super.payload
           end

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

@@ -23,7 +23,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def run
             puts("#{subject.identification} mutations: #{amount_mutations}")
             print_mutation_results
@@ -39,7 +38,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def print_stats
             status(
               FORMAT,
@@ -57,7 +55,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def print_tests
             tests.each do |test|
               puts "- #{test.identification}"
@@ -69,7 +66,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def print_progress_bar_finish
             puts(nil) unless amount_mutation_results.zero?
           end
@@ -79,7 +75,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def print_mutation_results
             visit_collection(MutationProgressResult, object.mutation_results)
           end

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

@@ -12,7 +12,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def run
             status(subject.identification)
             tests.each do |test|

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

@@ -16,7 +16,6 @@ module Mutant
           # @return [undefined]
           #
           # @api private
-          #
           def run
             info(STATUS_FORMAT, tests.length, runtime)
             tests.each do |test|

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

@@ -7,13 +7,15 @@ module Mutant
 
         private_class_method :new
 
-        # Return detected tput support
+        # Detected tput support
         #
         # @return [Tput]
         #   if tput support is present
         #
         # @return [nil]
         #   otherwise
+        #
+        # @api private
         def self.detect
           reset   = capture('tput reset')
           save    = capture('tput sc') if reset
@@ -33,6 +35,7 @@ module Mutant
         # @return [nil]
         #   otherwise
         #
+        # @api private
         def self.capture(command)
           stdout, _stderr, exitstatus = Open3.capture3(command)
           stdout if exitstatus.success?

data/lib/mutant/reporter/trace.rb

@@ -4,12 +4,11 @@ module Mutant
     class Trace
       include Adamantium::Mutable, Anima.new(:start_calls, :progress_calls, :report_calls, :warn_calls)
 
-      # Return new trace reporter
+      # New trace reporter
       #
       # @return [Trace]
       #
       # @api private
-      #
       def self.new
         super(Hash[anima.attribute_names.map { |name| [name, []] }])
       end
@@ -23,12 +22,11 @@ module Mutant
 
       REPORT_DELAY = 0.0
 
-      # Return report delay
+      # Report delay
       #
       # @return [Float]
       #
       # @api private
-      #
       def delay
         REPORT_DELAY
       end

data/lib/mutant/repository.rb

@@ -0,0 +1,88 @@
+module Mutant
+  module Repository
+    # Error raised on repository interaction problems
+    RepositoryError = Class.new(RuntimeError)
+
+    # Subject filter based on repository diff
+    class SubjectFilter
+      include Adamantium, Concord.new(:diff)
+
+      # Test if subject was touched in diff
+      #
+      # @param [Subject] subject
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def call(subject)
+        diff.touches?(subject.source_path, subject.source_lines)
+      end
+
+    end # SubjectFilter
+
+    # Diff between two objects in repository
+    class Diff
+      include Adamantium, Concord.new(:from, :to)
+
+      HEAD = 'HEAD'.freeze
+      private_constant(*constants(false))
+
+      # Create diff from head to revision
+      #
+      # @return [Diff]
+      #
+      # @api private
+      def self.from_head(to)
+        new(HEAD, to)
+      end
+
+      # Test if diff changes file at line range
+      #
+      # @param [Pathname] path
+      # @param [Range<Fixnum>] line_range
+      #
+      # @return [Boolean]
+      #
+      # @raise [RepositoryError]
+      #   when git command failed
+      #
+      # @api private
+      def touches?(path, line_range)
+        return false unless tracks?(path)
+
+        command = %W[
+          git log
+          #{from}...#{to}
+          -L #{line_range.begin},#{line_range.end}:#{path}
+        ]
+
+        stdout, status = Open3.capture2(*command, binmode: true)
+
+        fail RepositoryError, "Command #{command} failed!" unless status.success?
+
+        !stdout.empty?
+      end
+
+    private
+
+      # Test if path is tracked in repository
+      #
+      # FIXME: Cache results, to avoid spending time on producing redundant results.
+      #
+      # @param [Pathname] path
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def tracks?(path)
+        command = %W[git ls-files --error-unmatch -- #{path}]
+        Kernel.system(
+          *command,
+          out: File::NULL,
+          err: File::NULL
+        )
+      end
+
+    end # Diff
+  end # Repository
+end # Mutant

data/lib/mutant/require_highjack.rb

@@ -11,7 +11,6 @@ module Mutant
     #   the original implementation on singleton
     #
     # @api private
-    #
     def self.call(target, callback)
       target.method(:require).tap do
         target.module_eval do

data/lib/mutant/result.rb

@@ -4,33 +4,21 @@ module Mutant
 
     # Coverage mixin
     module Coverage
+      FULL_COVERAGE = Rational(1).freeze
+      private_constant(*constants(false))
 
-      # Return coverage
+      # Observed coverage
       #
       # @return [Rational]
       #
       # @api private
-      #
       def coverage
-        return Rational(0) if amount_mutation_results.zero?
-
-        Rational(amount_mutations_killed, amount_mutation_results)
-      end
-
-      # Hook called when module gets included
-      #
-      # @param [Class, Module] host
-      #
-      # @return [undefined]
-      #
-      # @api private
-      #
-      def self.included(host)
-        super
-
-        host.memoize(:coverage)
+        if amount_mutation_results.zero?
+          FULL_COVERAGE
+        else
+          Rational(amount_mutations_killed, amount_mutation_results)
+        end
       end
-
     end # Coverage
 
     # Class level mixin
@@ -47,7 +35,6 @@ module Mutant
       # @return [undefined]
       #
       # @api private
-      #
       def sum(name, collection)
         define_method(name) do
           public_send(collection).map(&name).reduce(0, :+)
@@ -56,12 +43,17 @@ module Mutant
       end
     end # ClassMethods
 
-    # Return overhead
+    private_constant(*constants(false))
+
+    # Mutant overhead running mutatet tests
+    #
+    # This is NOT the overhead of mutation testing, just an engine specific
+    # measurement for the efficiency of the parellelization engine, kill
+    # isolation etc.
     #
     # @return [Float]
     #
     # @api private
-    #
     def overhead
       runtime - killtime
     end
@@ -73,7 +65,6 @@ module Mutant
     # @return [undefined]
     #
     # @api private
-    #
     def self.included(host)
       host.class_eval do
         include Adamantium, Anima::Update
@@ -90,18 +81,16 @@ module Mutant
       # @return [Boolean]
       #
       # @api private
-      #
       def success?
         coverage.eql?(env.config.expected_coverage)
       end
       memoize :success?
 
-      # Return failed subject results
+      # Failed subject results
       #
       # @return [Array<Result::Subject>]
       #
       # @api private
-      #
       def failed_subject_results
         subject_results.reject(&:success?)
       end
@@ -111,22 +100,20 @@ module Mutant
       sum :amount_mutations_killed, :subject_results
       sum :killtime,                :subject_results
 
-      # Return amount of mutations
+      # Amount of mutations
       #
       # @return [Fixnum]
       #
       # @api private
-      #
       def amount_mutations
         env.mutations.length
       end
 
-      # Return amount of subjects
+      # Amount of subjects
       #
       # @return [Fixnum]
       #
       # @api private
-      #
       def amount_subjects
         env.subjects.length
       end
@@ -155,7 +142,6 @@ module Mutant
       # @return [Boolean]
       #
       # @api private
-      #
       def success?
         alive_mutation_results.empty?
       end
@@ -165,68 +151,61 @@ module Mutant
       # @return [Boolean]
       #
       # @api private
-      #
       def continue?
         mutation_results.all?(&:success?)
       end
 
-      # Return killed mutations
+      # Killed mutations
       #
       # @return [Array<Result::Mutation>]
       #
       # @api private
-      #
       def alive_mutation_results
         mutation_results.reject(&:success?)
       end
       memoize :alive_mutation_results
 
-      # Return amount of mutations
+      # Amount of mutations
       #
       # @return [Fixnum]
       #
       # @api private
-      #
       def amount_mutation_results
         mutation_results.length
       end
 
-      # Return amount of mutations
+      # Amount of mutations
       #
       # @return [Fixnum]
       #
       # @api private
-      #
       def amount_mutations
         subject.mutations.length
       end
 
-      # Return number of killed mutations
+      # Number of killed mutations
       #
       # @return [Fixnum]
       #
       # @api private
-      #
       def amount_mutations_killed
         killed_mutation_results.length
       end
 
-      # Return number of alive mutations
+      # Number of alive mutations
       #
       # @return [Fixnum]
       #
       # @api private
-      #
       def amount_mutations_alive
         alive_mutation_results.length
       end
 
-      # Return alive mutations
+      # Alive mutations
       #
       # @return [Array<Result::Mutation>]
       #
       # @api private
-      #
       def killed_mutation_results
         mutation_results.select(&:success?)
       end
@@ -238,12 +217,11 @@ module Mutant
     class Mutation
       include Result, Anima.new(:mutation, :test_result)
 
-      # Return runtime
+      # The runtime
       #
       # @return [Float]
       #
       # @api private
-      #
       def runtime
         test_result.runtime
       end
@@ -255,7 +233,6 @@ module Mutant
       # @return [Boolean]
       #
       # @api private
-      #
       def success?
         mutation.class.success?(test_result)
       end