mutant 0.9.4 → 0.9.9

data/config/reek.yml

@@ -136,3 +136,4 @@ detectors:
     - Mutant::Reporter::CLI::Printer::StatusProgressive#object # False positive calls super
     - Mutant::Repository::Diff#tracks? # intentional, private
     - Mutant::Repository::Diff#within_working_directory? # intentional, private
+    - Mutant::AST::FindMetaclassContaining#include_exact? # intentional, private

data/config/rubocop.yml

@@ -99,7 +99,7 @@ ClassCheck:
   EnforcedStyle: kind_of?
 
 # Do not prefer double quotes to be used when %q or %Q is more appropriate
-UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: false
 
 # Allow a maximum ABC score
@@ -145,7 +145,7 @@ Alias:
   EnforcedStyle: prefer_alias_method
 
 # Do not waste my horizontal or vertical space
-IndentArray:
+Layout/FirstArrayElementIndentation:
   Enabled: false
 
 # Prefer
@@ -167,7 +167,7 @@ MultilineMethodCallIndentation:
 Send:
   Enabled: true
 
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
 Layout/EmptyLineAfterGuardClause:
@@ -196,3 +196,10 @@ Style/RescueStandardError:
   Enabled: false
 Style/StderrPuts:
   Enabled: false
+# suggesting single letter variablesl bah
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+# false positive on private keywords
+Layout/IndentationWidth:
+  Enabled: false
+

data/docs/commercial-support.md

@@ -0,0 +1,14 @@
+# Commercial Support
+
+Mutant offers only community support.
+
+Commercial license customers are entited to priority support via email.
+
+## Priority Support
+
+Covers 1 incident per quarter, with a max response time of 7 days.
+Scope is limited to mutant not the application or infrastructure.
+
+For support email [Markus Schirp](mailto:mbj@schirp-dso.com?subject=Mutant%20Support).
+Please email using the same domain as the roiginal license email or explain
+your connection to the license.

data/lib/mutant.rb

@@ -21,6 +21,7 @@ require 'set'
 require 'singleton'
 require 'stringio'
 require 'unparser'
+require 'variable'
 require 'yaml'
 
 # This setting is done to make errors within the parallel
@@ -50,6 +51,7 @@ require 'mutant/ast/types'
 require 'mutant/ast/nodes'
 require 'mutant/ast/named_children'
 require 'mutant/ast/node_predicates'
+require 'mutant/ast/find_metaclass_containing'
 require 'mutant/ast/meta'
 require 'mutant/ast/meta/send'
 require 'mutant/ast/meta/const'
@@ -111,6 +113,7 @@ require 'mutant/mutator/node/send/conditional'
 require 'mutant/mutator/node/send/attribute_assignment'
 require 'mutant/mutator/node/when'
 require 'mutant/mutator/node/class'
+require 'mutant/mutator/node/sclass'
 require 'mutant/mutator/node/define'
 require 'mutant/mutator/node/mlhs'
 require 'mutant/mutator/node/nthref'
@@ -133,11 +136,13 @@ require 'mutant/subject'
 require 'mutant/subject/method'
 require 'mutant/subject/method/instance'
 require 'mutant/subject/method/singleton'
+require 'mutant/subject/method/metaclass'
 require 'mutant/matcher'
 require 'mutant/matcher/config'
 require 'mutant/matcher/chain'
 require 'mutant/matcher/method'
 require 'mutant/matcher/method/singleton'
+require 'mutant/matcher/method/metaclass'
 require 'mutant/matcher/method/instance'
 require 'mutant/matcher/methods'
 require 'mutant/matcher/namespace'
@@ -185,7 +190,6 @@ require 'mutant/reporter/cli/format'
 require 'mutant/repository'
 require 'mutant/repository/diff'
 require 'mutant/repository/diff/ranges'
-require 'mutant/variable'
 require 'mutant/warnings'
 require 'mutant/zombifier'
 require 'mutant/range'

data/lib/mutant/ast.rb

@@ -27,15 +27,6 @@ module Mutant
       path
     end
 
-    # Walk all ast nodes keeping track of path
-    #
-    # @param [Parser::AST::Node] root
-    # @param [Array<Parser::AST::Node>] stack
-    #
-    # @yield [Parser::AST::Node]
-    #   all nodes visited recursively including root
-    #
-    # @return [undefined]
     def self.walk(node, stack, &block)
       block.call(node, stack)
       node.children.grep(::Parser::AST::Node) do |child|

data/lib/mutant/ast/find_metaclass_containing.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Mutant
+  module AST
+    # Given an AST, finds the sclass that directly(-ish) contains the provided
+    # node.
+    # This won't match arbitrarily complex structures - it only searches the
+    # first level deep (no begins-in-begins, for example). This is in
+    # keeping with mutant generally not supporting 'weird' syntax.
+    # Descending into 'begin' nodes is supported because these are generated for
+    # the one-line syntax class << self; def foo; end
+    class FindMetaclassContaining
+      include NodePredicates, Concord.new(:root, :target), Procto.call
+
+      SCLASS_BODY_INDEX = 1
+
+      private_constant(*constants(false))
+
+      # Find metaclass node containing target node
+      #
+      # @return [Parser::AST::Node, nil]
+      #
+      # @api private
+      def call
+        AST.find_last_path(root) do |current|
+          next unless n_sclass?(current)
+
+          metaclass_of?(current)
+        end.last
+      end
+
+    private
+
+      def metaclass_of?(sclass)
+        body = sclass.children.fetch(SCLASS_BODY_INDEX)
+        body.equal?(target) || transparently_contains?(body)
+      end
+
+      def transparently_contains?(body)
+        n_begin?(body) && include_exact?(body.children, target)
+      end
+
+      def include_exact?(haystack, needle)
+        haystack.any? { |elem| elem.equal?(needle) }
+      end
+    end
+  end
+end

data/lib/mutant/ast/meta/send.rb

@@ -56,16 +56,10 @@ module Mutant
 
       private
 
-        # Test if node is `proc { ... }`
-        #
-        # @return [Boolean]
         def naked_proc?
           !receiver && selector.equal?(:proc)
         end
 
-        # Test if node is `Proc.new { ... }`
-        #
-        # @return [Boolean]
         def proc_new?
           receiver                &&
             selector.equal?(:new) &&

data/lib/mutant/bootstrap.rb

@@ -49,9 +49,6 @@ module Mutant
     end
     # rubocop:enable Metrics/MethodLength
 
-    # Infect environment
-    #
-    # @return [undefined]
     def self.infect(env)
       config, world = env.config, env.world
 
@@ -60,12 +57,6 @@ module Mutant
     end
     private_class_method :infect
 
-    # Matchable scopes
-    #
-    # @param [World] world
-    # @param [Config] config
-    #
-    # @return [Array<Scope>]
     def self.matchable_scopes(world, config)
       scopes = world.object_space.each_object(Module).each_with_object([]) do |scope, aggregate|
         expression = expression(config.reporter, config.expression_parser, scope) || next
@@ -76,15 +67,6 @@ module Mutant
     end
     private_class_method :matchable_scopes
 
-    # Scope name from scoping object
-    #
-    # @param [Class, Module] scope
-    #
-    # @return [String]
-    #   if scope has a name and does not raise exceptions obtaining it
-    #
-    # @return [nil]
-    #   otherwise
     def self.scope_name(reporter, scope)
       scope.name
     rescue => exception
@@ -99,20 +81,7 @@ module Mutant
     end
     private_class_method :scope_name
 
-    # Try to turn scope into expression
-    #
-    # @param [Expression::Parser] expression_parser
-    # @param [Class, Module] scope
-    #
-    # @return [Expression]
-    #   if scope can be represented in an expression
-    #
-    # @return [nil]
-    #   otherwise
-    #
     # rubocop:disable Metrics/MethodLength
-    #
-    # ignore :reek:LongParameterList
     def self.expression(reporter, expression_parser, scope)
       name = scope_name(reporter, scope) or return
 
@@ -132,11 +101,6 @@ module Mutant
     private_class_method :expression
     # rubocop:enable Metrics/MethodLength
 
-    # Write a semantics warning
-    #
-    # @return [undefined]
-    #
-    # ignore :reek:LongParameterList
     def self.semantics_warning(reporter, format, options)
       reporter.warn(SEMANTICS_MESSAGE_FORMAT % { message: format % options })
     end

data/lib/mutant/cli.rb

@@ -88,24 +88,13 @@ module Mutant
 
   private
 
-    # Parse matchers
-    #
-    # @param [Array<String>] expressions
-    #
-    # @return [undefined]
     def parse_match_expressions(expressions)
       expressions.each do |expression|
         add_matcher(:match_expressions, config.expression_parser.apply(expression).from_right)
       end
     end
 
-    # Add environmental options
-    #
-    # @param [Object] opts
-    #
-    # @return [undefined]
-    #
-    # rubocop:disable MethodLength
+    # rubocop:disable Metrics/MethodLength
     def add_environment_options(opts)
       opts.separator('Environment:')
       opts.on('--zombie', 'Run mutant zombified') do
@@ -121,12 +110,8 @@ module Mutant
         with(jobs: Integer(number))
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
-    # Add mutation options
-    #
-    # @param [OptionParser] opts
-    #
-    # @return [undefined]
     def add_mutation_options(opts)
       opts.separator(nil)
       opts.separator('Options:')
@@ -136,11 +121,7 @@ module Mutant
       end
     end
 
-    # Add filter options
-    #
-    # @param [OptionParser] opts
-    #
-    # @return [undefined]
+    # rubocop:disable Metrics/MethodLength
     def add_filter_options(opts)
       opts.on('--ignore-subject EXPRESSION', 'Ignore subjects that match EXPRESSION as prefix') do |pattern|
         add_matcher(:ignore_expressions, config.expression_parser.apply(pattern).from_right)
@@ -154,12 +135,9 @@ module Mutant
         )
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
-    # Add debug options
-    #
-    # @param [OptionParser] opts
-    #
-    # @return [undefined]
+    # rubocop:disable Metrics/MethodLength
     def add_debug_options(opts)
       opts.on('--fail-fast', 'Fail fast') do
         with(fail_fast: true)
@@ -173,38 +151,16 @@ module Mutant
         world.kernel.exit
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
-    # With configuration
-    #
-    # @param [Hash<Symbol, Object>] attributes
-    #
-    # @return [undefined]
     def with(attributes)
       @config = config.with(attributes)
     end
 
-    # Add configuration
-    #
-    # @param [Symbol] attribute
-    #   the attribute to add to
-    #
-    # @param [Object] value
-    #   the value to add
-    #
-    # @return [undefined]
     def add(attribute, value)
       with(attribute => config.public_send(attribute) + [value])
     end
 
-    # Add matcher configuration
-    #
-    # @param [Symbol] attribute
-    #   the attribute to add to
-    #
-    # @param [Object] value
-    #   the value to add
-    #
-    # @return [undefined]
     def add_matcher(attribute, value)
       with(matcher: config.matcher.add(attribute, value))
     end

data/lib/mutant/color.rb

@@ -28,9 +28,6 @@ module Mutant
 
     private
 
-      # Initialize null color
-      #
-      # @return [undefined]
       def initialize; end
 
     end.new

data/lib/mutant/config.rb

@@ -126,14 +126,6 @@ module Mutant
       end
     end
 
-    # Load contents of file
-    #
-    # @param [Pathname] path
-    #
-    # @return [Config]
-    #
-    # @raise [Either<String, Hash{Symbol => Object}>]
-    #   in case of config file error
     def self.load_contents(path)
       Transform::Named
         .new(path.to_s, TRANSFORM)

data/lib/mutant/context.rb

@@ -81,9 +81,6 @@ module Mutant
 
   private
 
-    # Nesting of names in scope
-    #
-    # @return [Array<String>]
     def name_nesting
       scope.name.split(NAMESPACE_DELIMITER)
     end

data/lib/mutant/diff.rb

@@ -58,25 +58,16 @@ module Mutant
 
   private
 
-    # Diffs between old and new
-    #
-    # @return [Array<Array>]
     def diffs
       ::Diff::LCS.diff(old, new)
     end
 
-    # Raw diff-lcs hunks
-    #
-    # @return [Array<Diff::LCS::Hunk>]
     def hunks
       diffs.map do |diff|
         ::Diff::LCS::Hunk.new(old.map(&:dup), new, diff, max_length, 0)
       end
     end
 
-    # Minimized hunk
-    #
-    # @return Diff::LCS::Hunk
     def minimized_hunk
       head, *tail = hunks
 
@@ -86,18 +77,10 @@ module Mutant
       end
     end
 
-    # Max length of source line in new and old
-    #
-    # @return [Integer]
     def max_length
       [old, new].map(&:length).max
     end
 
-    # Colorized a unified diff line
-    #
-    # @param [String] line
-    #
-    # @return [String]
     def self.colorize_line(line)
       case line[0]
       when ADDITION

data/lib/mutant/env.rb

@@ -126,12 +126,6 @@ module Mutant
 
   private
 
-    # Kill mutation under isolation with integration
-    #
-    # @param [Mutation] mutation
-    # @param [Array<Test>] test
-    #
-    # @return [Result::Isolation]
     def run_mutation_tests(mutation, tests)
       config.isolation.call do
         result = mutation.insert(world.kernel)