mutant 0.11.11 → 0.11.14

data/lib/mutant/config.rb

@@ -19,7 +19,7 @@ module Mutant
       :isolation,
       :jobs,
       :matcher,
-      :mutation_timeout,
+      :mutation,
       :reporter,
       :requires,
       :zombie
@@ -39,6 +39,20 @@ module Mutant
       mutant.yml
     ].freeze
 
+    MUTATION_TIMEOUT_DEPRECATION = <<~'MESSAGE'
+      Deprecated configuration toplevel key `mutation_timeout` found.
+
+      This key will be removed in the next major version.
+      Instead place your mutation timeout configuration under the `mutation` key
+      like this:
+
+      ```
+      # mutant.yml
+      mutation:
+        timeout: 10.0 # float here.
+      ```
+    MESSAGE
+
     private_constant(*constants(false))
 
     # Merge with other config
@@ -59,7 +73,7 @@ module Mutant
         integration:           other.integration || integration,
         jobs:                  other.jobs || jobs,
         matcher:               matcher.merge(other.matcher),
-        mutation_timeout:      other.mutation_timeout || mutation_timeout,
+        mutation:              mutation.merge(other.mutation),
         requires:              requires + other.requires,
         zombie:                zombie || other.zombie
       )
@@ -69,17 +83,16 @@ module Mutant
 
     # Load config file
     #
-    # @param [World] world
-    # @param [Config] config
+    # @param [Env] env
     #
     # @return [Either<String,Config>]
-    def self.load_config_file(world)
+    def self.load_config_file(env)
       files = CANDIDATES
-        .map(&world.pathname.public_method(:new))
+        .map(&env.world.pathname.public_method(:new))
         .select(&:readable?)
 
       if files.one?
-        load_contents(files.first).fmap(&DEFAULT.public_method(:with))
+        load_contents(env, files.first).fmap(&DEFAULT.public_method(:with))
       elsif files.empty?
         Either::Right.new(DEFAULT)
       else
@@ -97,14 +110,30 @@ module Mutant
       )
     end
 
-    def self.load_contents(path)
+    def self.load_contents(env, path)
       Transform::Named
-        .new(path.to_s, TRANSFORM)
+        .new(
+          path.to_s,
+          sequence(env.config.reporter)
+        )
         .call(path)
         .lmap(&:compact_message)
     end
     private_class_method :load_contents
 
+    def self.sequence(reporter)
+      Transform::Sequence.new(
+        [
+          Transform::Exception.new(SystemCallError, :read.to_proc),
+          Transform::Exception.new(YAML::SyntaxError, YAML.public_method(:safe_load)),
+          Transform::Primitive.new(Hash),
+          Transform::Success.new(->(hash) { deprecations(reporter, hash) }),
+          *TRANSFORMS
+        ]
+      )
+    end
+    private_class_method :sequence
+
     # The configuration from the environment
     #
     # @return [Config]
@@ -139,38 +168,45 @@ module Mutant
 
       Either::Right.new(hash)
     end
-    TRANSFORM = Transform::Sequence.new(
-      [
-        Transform::Exception.new(SystemCallError, :read.to_proc),
-        Transform::Exception.new(YAML::SyntaxError, YAML.public_method(:safe_load)),
-        Transform::Hash.new(
-          optional: [
-            Transform::Hash::Key.new('coverage_criteria', ->(value) { CoverageCriteria::TRANSFORM.call(value) }),
-            Transform::Hash::Key.new(
-              'environment_variables',
-              Transform::Sequence.new(
-                [
-                  Transform::Primitive.new(Hash),
-                  Transform::Block.capture(:environment_variables, &method(:parse_environment_variables))
-                ]
-              )
-            ),
-            Transform::Hash::Key.new('fail_fast',             Transform::BOOLEAN),
-            Transform::Hash::Key.new('hooks',                 PATHNAME_ARRAY),
-            Transform::Hash::Key.new('includes',              Transform::STRING_ARRAY),
-            Transform::Hash::Key.new('integration',           Transform::STRING),
-            Transform::Hash::Key.new('jobs',                  Transform::INTEGER),
-            Transform::Hash::Key.new('matcher',               Matcher::Config::LOADER),
-            Transform::Hash::Key.new('mutation_timeout',      Transform::FLOAT),
-            Transform::Hash::Key.new('requires',              Transform::STRING_ARRAY)
-          ],
-          required: []
-        ),
-        Transform::Hash::Symbolize.new
-      ]
-    )
 
-    private_constant(:TRANSFORM)
+    def self.deprecations(reporter, hash)
+      if hash.key?('mutation_timeout')
+        reporter.warn(MUTATION_TIMEOUT_DEPRECATION)
+
+        (hash['mutation'] ||= {})['timeout'] ||= hash.delete('mutation_timeout')
+      end
+
+      hash
+    end
+
+    TRANSFORMS = [
+      Transform::Hash.new(
+        optional: [
+          Transform::Hash::Key.new('coverage_criteria', ->(value) { CoverageCriteria::TRANSFORM.call(value) }),
+          Transform::Hash::Key.new(
+            'environment_variables',
+            Transform::Sequence.new(
+              [
+                Transform::Primitive.new(Hash),
+                Transform::Block.capture(:environment_variables, &method(:parse_environment_variables))
+              ]
+            )
+          ),
+          Transform::Hash::Key.new('fail_fast',   Transform::BOOLEAN),
+          Transform::Hash::Key.new('hooks',       PATHNAME_ARRAY),
+          Transform::Hash::Key.new('includes',    Transform::STRING_ARRAY),
+          Transform::Hash::Key.new('integration', Transform::STRING),
+          Transform::Hash::Key.new('jobs',        Transform::INTEGER),
+          Transform::Hash::Key.new('matcher',     Matcher::Config::LOADER),
+          Transform::Hash::Key.new('mutation',    Mutation::Config::TRANSFORM),
+          Transform::Hash::Key.new('requires',    Transform::STRING_ARRAY)
+        ],
+        required: []
+      ),
+      Transform::Hash::Symbolize.new
+    ].freeze
+
+    private_constant(:TRANSFORMS)
   end # Config
   # rubocop:enable Metrics/ClassLength
 end # Mutant

data/lib/mutant/env.rb

@@ -137,7 +137,7 @@ module Mutant
   private
 
     def run_mutation_tests(mutation, tests)
-      config.isolation.call(config.mutation_timeout) do
+      config.isolation.call(config.mutation.timeout) do
         hooks.run(:mutation_insert_pre, mutation)
         result = mutation.insert(world.kernel)
         hooks.run(:mutation_insert_post, mutation)

data/lib/mutant/license/subscription/opensource.rb

@@ -18,7 +18,7 @@ module Mutant
           end
 
           def self.parse(input)
-            new(*input.split('/', 2))
+            new(*input.split('/', 2).map(&:downcase))
           end
 
           def self.parse_remote(input)
@@ -39,7 +39,17 @@ module Mutant
             new(match[:host], match[:path].downcase)
           end
           private_class_method :parse_url
-        end
+
+          def allow?(other)
+            other.host.eql?(host) && path_match?(other.path)
+          end
+
+        private
+
+          def path_match?(other_path)
+            path.eql?(other_path) || (path.end_with?('/*') && other_path.start_with?(path[..-2]))
+          end
+        end # Opensource
 
         def self.from_json(value)
           new(
@@ -60,7 +70,7 @@ module Mutant
       private
 
         def check_subscription(actual)
-          if (licensed & actual).any?
+          if licensed.any? { |repository| actual.any? { |other| repository.allow?(other) } }
             success
           else
             failure(licensed, actual)

data/lib/mutant/matcher/method/instance.rb

@@ -30,8 +30,9 @@ module Mutant
 
         # Instance method specific evaluator
         class Evaluator < Evaluator
-          SUBJECT_CLASS = Subject::Method::Instance
-          NAME_INDEX    = 0
+          MATCH_NODE_TYPE = :def
+          NAME_INDEX      = 0
+          SUBJECT_CLASS   = Subject::Method::Instance
 
         private
 

data/lib/mutant/matcher/method/metaclass.rb

@@ -22,10 +22,11 @@ module Mutant
         # Metaclass method evaluator
         class Evaluator < Evaluator
           # Terminology note: the "receiver" is the `self` in `class << self`
-          SUBJECT_CLASS         = Subject::Method::Metaclass
-          NAME_INDEX            = 0
           CONST_NAME_INDEX      = 1
+          MATCH_NODE_TYPE       = :def
+          NAME_INDEX            = 0
           SCLASS_RECEIVER_INDEX = 0
+          SUBJECT_CLASS         = Subject::Method::Metaclass
           RECEIVER_WARNING      = 'Can only match :def inside :sclass on ' \
                                   ':self or :const, got :sclass on %p ' \
                                   'unable to match'
@@ -45,7 +46,7 @@ module Mutant
           end
 
           def metaclass_containing(node)
-            AST::FindMetaclassContaining.call(ast.node, node)
+            AST::FindMetaclassContaining.call(ast, node)
           end
 
           def line?(node)

data/lib/mutant/matcher/method/singleton.rb

@@ -18,10 +18,11 @@ module Mutant
 
         # Singleton method evaluator
         class Evaluator < Evaluator
-          SUBJECT_CLASS    = Subject::Method::Singleton
-          RECEIVER_INDEX   = 0
+          MATCH_NODE_TYPE  = :defs
           NAME_INDEX       = 1
+          RECEIVER_INDEX   = 0
           RECEIVER_WARNING = 'Can only match :defs on :self or :const got %p unable to match'
+          SUBJECT_CLASS    = Subject::Method::Singleton
 
         private
 

data/lib/mutant/matcher/method.rb

@@ -41,23 +41,38 @@ module Mutant
         #
         # @return [Enumerable<Subject>]
         def call
-          return EMPTY_ARRAY if skip?
+          location = source_location
+
+          if location.nil? || !location.first.end_with?('.rb')
+            env.warn(SOURCE_LOCATION_WARNING_FORMAT % target_method)
 
-          [subject].compact
+            return EMPTY_ARRAY
+          end
+
+          match_view
         end
 
       private
 
-        def skip?
-          location = source_location
-
-          file = location&.first
+        def match_view
+          return EMPTY_ARRAY if matched_view.nil?
 
-          if location.nil? || !file.end_with?('.rb')
-            env.warn(SOURCE_LOCATION_WARNING_FORMAT % target_method)
-          elsif matched_node_path.any?(&method(:n_block?))
+          if matched_view.path.any?(&:block.public_method(:equal?))
             env.warn(CLOSURE_WARNING_FORMAT % target_method)
+
+            return EMPTY_ARRAY
           end
+
+          [subject]
+        end
+
+        def subject
+          self.class::SUBJECT_CLASS.new(
+            config:     subject_config(matched_view.node),
+            context:    context,
+            node:       matched_view.node,
+            visibility: visibility
+          )
         end
 
         def method_name
@@ -95,21 +110,22 @@ module Mutant
           T::Private::Methods.signature_for_method(target_method)
         end
 
-        def subject
-          node = matched_node_path.last || return
-
-          self.class::SUBJECT_CLASS.new(
-            config:     Subject::Config.parse(ast.comment_associations.fetch(node, [])),
-            context:    context,
-            node:       node,
-            visibility: visibility
+        def subject_config(node)
+          Subject::Config.parse(
+            comments: ast.comment_associations.fetch(node, []),
+            mutation: env.config.mutation
           )
         end
 
-        def matched_node_path
-          AST.find_last_path(ast.node, &method(:match?))
+        def matched_view
+          return if source_location.nil?
+
+          ast
+            .on_line(source_line)
+            .select { |view| view.node.type.eql?(self.class::MATCH_NODE_TYPE) && match?(view.node) }
+            .last
         end
-        memoize :matched_node_path
+        memoize :matched_view
 
         def visibility
           # This can be cleaned up once we are on >ruby-3.0

data/lib/mutant/meta/example.rb

@@ -55,7 +55,10 @@ module Mutant
       #
       # @return [Enumerable<Mutant::Mutation>]
       def generated
-        Mutator.mutate(node).map do |node|
+        Mutator::Node.mutate(
+          config: Mutation::Config::DEFAULT,
+          node:   node
+        ).map do |node|
           Mutation::Evil.new(self, node)
         end
       end

data/lib/mutant/mutation/config.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Mutant
+  class Mutation
+    class Config
+      include Anima.new(:ignore_patterns, :timeout)
+
+      DEFAULT = new(
+        timeout:         nil,
+        ignore_patterns: []
+      )
+
+      ignore_pattern = Transform::Block.capture('ignore pattern', &AST::Pattern.method(:parse))
+
+      TRANSFORM = Transform::Sequence.new(
+        [
+          Transform::Hash.new(
+            optional: [
+              Transform::Hash::Key.new('ignore_patterns', Transform::Array.new(ignore_pattern)),
+              Transform::Hash::Key.new('timeout',         Transform::FLOAT)
+            ],
+            required: []
+          ),
+          Transform::Hash::Symbolize.new,
+          Transform::Success.new(DEFAULT.method(:with))
+        ]
+      )
+
+      def merge(other)
+        with(
+          timeout: other.timeout || timeout
+        )
+      end
+    end # Config
+  end # Mutation
+end # Mutant

data/lib/mutant/mutator/node/arguments.rb

@@ -50,7 +50,7 @@ module Mutant
 
         def emit_argument_mutations
           children.each_with_index do |child, index|
-            Mutator.mutate(child).each do |mutant|
+            mutate(node: child).each do |mutant|
               next if invalid_argument_replacement?(mutant, index)
               emit_child_update(index, mutant)
             end

data/lib/mutant/mutator/node/begin.rb

@@ -12,8 +12,9 @@ module Mutant
       private
 
         def dispatch
+          ignore_single = children.any?(&method(:ignore?))
           mutate_single_child do |child|
-            emit(child)
+            emit(child) unless ignore_single
           end
         end
       end # Begin

data/lib/mutant/mutator/node/block.rb

@@ -38,9 +38,11 @@ module Mutant
         end
 
         def body_has_control?
-          AST.find_last_path(body) do |node|
-            n_break?(node) || n_next?(node)
-          end.any?
+          AST::Structure.for(body.type).each_node(body) do |node|
+            return true if n_break?(node) || n_next?(node)
+          end
+
+          false
         end
 
         def mutate_body_receiver

data/lib/mutant/mutator/node/define.rb

@@ -13,8 +13,11 @@ module Mutant
           emit_optarg_body_assignments
           emit_body(N_RAISE)
           emit_body(N_ZSUPER)
-          emit_body(nil)
-          emit_body_mutations if body
+
+          return unless body && !ignore?(body)
+
+          emit_body(nil) unless body.children.any?(&method(:ignore?))
+          emit_body_mutations
         end
 
         def emit_optarg_body_assignments

data/lib/mutant/mutator/node/kwargs.rb

@@ -20,14 +20,14 @@ module Mutant
         end
 
         def emit_argument_presence
-          Util::Array::Presence.call(children).each do |children|
+          Util::Array::Presence.call(input: children, parent: nil).each do |children|
             emit_type(*children) unless children.empty?
           end
         end
 
         def emit_argument_mutations
           children.each_with_index do |child, index|
-            Mutator.mutate(child).each do |mutant|
+            mutate(node: child).each do |mutant|
               unless forbid_argument?(mutant)
                 emit_child_update(index, mutant)
               end

data/lib/mutant/mutator/node/literal/regex.rb

@@ -33,7 +33,7 @@ module Mutant
             # Regular expressions with interpolation are skipped.
             return unless (body_ast = AST::Regexp.expand_regexp_ast(input))
 
-            Mutator.mutate(body_ast).each do |mutation|
+            mutate(node: body_ast).each do |mutation|
               source = AST::Regexp.to_expression(mutation).to_s
               emit_type(s(:str, source), options)
             end

data/lib/mutant/mutator/node/literal/symbol.rb

@@ -15,9 +15,9 @@ module Mutant
 
           def dispatch
             emit_singletons
-            Util::Symbol.call(value).each(&method(:emit_type))
-          end
 
+            Util::Symbol.call(input: value, parent: nil).each(&method(:emit_type))
+          end
         end # Symbol
       end # Literal
     end # Node

data/lib/mutant/mutator/node/named_value/constant_assignment.rb

@@ -26,7 +26,7 @@ module Mutant
           end
 
           def mutate_name
-            Util::Symbol.call(name).each do |name|
+            Util::Symbol.call(input: name, parent: nil).each do |name|
               emit_name(name.upcase)
             end
           end

data/lib/mutant/mutator/node/named_value/variable_assignment.rb

@@ -34,11 +34,11 @@ module Mutant
           def mutate_name
             prefix, regexp = MAP.fetch(node.type)
             stripped = name.to_s.sub(regexp, EMPTY_STRING)
-            Util::Symbol.call(stripped).each do |name|
+
+            Util::Symbol.call(input: stripped, parent: nil).each do |name|
               emit_name(:"#{prefix}#{name}")
             end
           end
-
         end # VariableAssignment
       end # NamedValue
     end # Node

data/lib/mutant/mutator/node/resbody.rb

@@ -15,17 +15,7 @@ module Mutant
         def dispatch
           emit_assignment(nil)
           emit_body_mutations if body
-          mutate_captures
         end
-
-        def mutate_captures
-          return unless captures
-          Util::Array::Element.call(captures.children).each do |matchers|
-            next if matchers.any?(&method(:n_nil?))
-            emit_captures(s(:array, *matchers))
-          end
-        end
-
       end # Resbody
     end # Node
   end # Mutator

data/lib/mutant/mutator/node.rb

@@ -10,8 +10,37 @@ module Mutant
       include AbstractType, Unparser::Constants
       include AST::NamedChildren, AST::NodePredicates, AST::Sexp, AST::Nodes
 
+      include anima.add(:config)
+
       TAUTOLOGY = ->(_input) { true }
 
+      REGISTRY = Registry.new(->(_) { Node::Generic })
+
+      # Lookup and invoke dedicated AST mutator
+      #
+      # @param input [Parser::AST::Node]
+      # @param parent [nil,Mutant::Mutator::Node]
+      #
+      # @return [Set<Parser::AST::Node>]
+      def self.mutate(config:, node:, parent: nil)
+        config.ignore_patterns.each do |pattern|
+          return Set.new if pattern.match?(node)
+        end
+
+        self::REGISTRY.lookup(node.type).call(
+          config: config,
+          input:  node,
+          parent: parent
+        )
+      end
+
+      def self.handle(*types)
+        types.each do |type|
+          self::REGISTRY.register(type, self)
+        end
+      end
+      private_class_method :handle
+
       # Helper to define a named child
       #
       # @param [Parser::AST::Node] node
@@ -37,9 +66,13 @@ module Mutant
       alias_method :node,     :input
       alias_method :dup_node, :dup_input
 
+      def mutate(node:, parent: nil)
+        self.class.mutate(config: config, node: node, parent: parent)
+      end
+
       def mutate_child(index, &block)
         block ||= TAUTOLOGY
-        Mutator.mutate(children.fetch(index), self).each do |mutation|
+        mutate(node: children.fetch(index), parent: self).each do |mutation|
           next unless block.call(mutation)
           emit_child_update(index, mutation)
         end
@@ -96,6 +129,19 @@ module Mutant
         end
       end
 
+      def run(mutator)
+        mutator.call(
+          config: config,
+          input:  input,
+          parent: nil
+        ).each(&method(:emit))
+      end
+
+      def ignore?(node)
+        config.ignore_patterns.any? do |pattern|
+          pattern.match?(node)
+        end
+      end
     end # Node
   end # Mutator
 end # Mutant

data/lib/mutant/mutator/util/array.rb

@@ -21,23 +21,6 @@ module Mutant
           end
 
         end # Presence
-
-        # Array element mutator
-        class Element < Util
-
-        private
-
-          def dispatch
-            input.each_with_index do |element, index|
-              Mutator.mutate(element).each do |mutation|
-                dup = dup_input
-                dup[index] = mutation
-                emit(dup)
-              end
-            end
-          end
-
-        end # Element
       end # Array
     end # Util
   end # Mutator