mutant 0.10.29 → 0.10.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 287c627187afa2b42509eccfbb1f6c9d6a0122b6fc27bc518746ecc4db406da5
-  data.tar.gz: a7310138beb4d7b415f627d82cfcb7cd6149f9d9f06272c1b31e15bfa0ec7375
+  metadata.gz: 2c20fb3fdc41f7d6e0f8164916206353716c037ec596fccccd06db10c05e810c
+  data.tar.gz: 276612decdc11bf06de38e704fed0d6dc3b9b0b590d9e2f333be7ae383396ca0
 SHA512:
-  metadata.gz: 607876e535726ad8c39b1ba7d2b9cd18ca93e6579ee62142a38b31c9f4cd856d49f828398b7bee7e963ae8029b6b3f41772d2e3df6e527dd71bf303009f80f15
-  data.tar.gz: 7957de07e7554b3921be9311d4ea2fa67a4068c62794466853972157beeb504a20de97856001cf17decc9730b99df509c45a539db81769c42c0ecb31abd9d610
+  metadata.gz: 652ac4959565f27514568c25c43a0ab64d3af74f9f9de50712bf6e6e825dcf44d27e55e40ff76f0e7c91e27c4199c4f67a0d2205f2268eefae5acc338e2aecb5
+  data.tar.gz: a7e9b023ffefb0d3da5a13d7ec83fbb6696a10efe0f8840b867e8f6e788a55e7d2eabd077173957a697e9f0689ce109fec5d8668078946e317f7c9c4b7216614

data/bin/mutant

@@ -22,7 +22,7 @@ status =
       kernel:           Kernel,
       pathname:         Pathname,
       require_highjack: Mutant::RequireHighjack
-        .method(:call)
+        .public_method(:call)
         .to_proc
         .curry
         .call(Kernel),

data/lib/mutant/ast/regexp/transformer/direct.rb

@@ -74,6 +74,7 @@ module Mutant
               [:regexp_katakana_property,        [:property,      :katakana,         '\p{Katakana}'], ::Regexp::Expression::UnicodeProperty::Script],
               [:regexp_letter_property,          [:property,      :letter,           '\p{L}'],        ::Regexp::Expression::UnicodeProperty::Letter::Any],
               [:regexp_linebreak_type,           [:type,          :linebreak,        '\R'],           ::Regexp::Expression::CharacterType::Linebreak],
+              [:regexp_latin_property,           [:property,      :latin,            '\p{Latin}'],    ::Regexp::Expression::UnicodeProperty::Script],
               [:regexp_lower_posixclass,         [:posixclass,    :lower,            '[:lower:]'],    ::Regexp::Expression::PosixClass],
               [:regexp_mark_keep,                [:keep,          :mark,             '\K'],           ::Regexp::Expression::Keep::Mark],
               [:regexp_match_start_anchor,       [:anchor,        :match_start,      '\\G'],          ::Regexp::Expression::Anchor::MatchStart],

data/lib/mutant/ast/regexp/transformer.rb

@@ -11,7 +11,9 @@ module Mutant
       class Transformer
         include AbstractType
 
-        REGISTRY = Registry.new
+        REGISTRY = Registry.new(
+          ->(type) { fail "No regexp transformer registered for: #{type}" }
+        )
 
         # Lookup transformer class for regular expression node type
         #

data/lib/mutant/ast/types.rb

@@ -107,6 +107,7 @@ module Mutant
         regexp_interval_close_escape
         regexp_interval_open_escape
         regexp_katakana_property
+        regexp_latin_property
         regexp_letter_property
         regexp_linebreak_type
         regexp_literal_escape

data/lib/mutant/bootstrap.rb

@@ -31,8 +31,7 @@ module Mutant
     #
     # rubocop:disable Metrics/MethodLength
     def self.call(world, config)
-      env = Env
-        .empty(world, config)
+      env = load_hooks(Env.empty(world, config))
         .tap(&method(:infect))
         .with(matchable_scopes: matchable_scopes(world, config))
 
@@ -49,6 +48,11 @@ module Mutant
     end
     # rubocop:enable Metrics/MethodLength
 
+    def self.load_hooks(env)
+      env.with(hooks: Hooks.load_config(env.config))
+    end
+    private_class_method :load_hooks
+
     def self.start_subject(env, subjects)
       start_expressions = env.config.matcher.start_expressions
 
@@ -63,10 +67,14 @@ module Mutant
     private_class_method :start_subject
 
     def self.infect(env)
-      config, world = env.config, env.world
+      config, hooks, world = env.config, env.hooks, env.world
+
+      hooks.run(:env_infection_pre, env)
+
+      config.includes.each(&world.load_path.public_method(:<<))
+      config.requires.each(&world.kernel.public_method(:require))
 
-      config.includes.each(&world.load_path.method(:<<))
-      config.requires.each(&world.kernel.method(:require))
+      hooks.run(:env_infection_post, env)
     end
     private_class_method :infect
 

data/lib/mutant/cli/command/root.rb

@@ -10,7 +10,7 @@ module Mutant
       class Root < self
         NAME              = 'mutant'
         SHORT_DESCRIPTION = 'mutation testing engine main command'
-        SUBCOMMANDS       = [Environment::Run, Environment, Subscription].freeze
+        SUBCOMMANDS       = [Environment::Run, Environment, Subscription, Util].freeze
       end # Root
     end # Command
   end # CLI

data/lib/mutant/cli/command/util.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Mutant
+  module CLI
+    class Command
+      class Util < self
+        NAME              = 'util'
+        SHORT_DESCRIPTION = 'Utility subcommands'
+
+        class Mutation < self
+          NAME              = 'mutation'
+          SHORT_DESCRIPTION = 'Print mutations of a code snippet'
+          SUBCOMMANDS       = [].freeze
+          OPTIONS           = %i[add_target_options].freeze
+
+          def action
+            @targets.each(&method(:print_mutations))
+            Either::Right.new(nil)
+          end
+
+        private
+
+          class Target
+            include Adamantium
+
+            def node
+              Unparser.parse(source)
+            end
+            memoize :node
+
+            class File < self
+              include Concord.new(:pathname, :source)
+
+              public :source
+
+              def identification
+                "file:#{pathname}"
+              end
+            end # File
+
+            class Source < self
+              include Concord::Public.new(:source)
+
+              def identification
+                '<cli-source>'
+              end
+            end # source
+          end # Target
+
+          def initialize(_arguments)
+            super
+
+            @targets = []
+          end
+
+          def add_target_options(parser)
+            parser.on('-e', '--evaluate SOURCE') do |source|
+              @targets << Target::Source.new(source)
+            end
+          end
+
+          def print_mutations(target)
+            world.stdout.puts(target.identification)
+            Mutator.mutate(target.node).each do |mutation|
+              Reporter::CLI::Printer::Mutation.call(
+                world.stdout,
+                Mutant::Mutation::Evil.new(target, mutation)
+              )
+            end
+          end
+
+          def parse_remaining_arguments(arguments)
+            @targets.concat(
+              arguments.map do |argument|
+                parse_pathname(argument)
+                  .bind(&method(:read_file))
+                  .from_right { |error| return Either::Left.new(error) }
+              end
+            )
+
+            Either::Right.new(self)
+          end
+
+          def read_file(pathname)
+            Either::Right.new(Target::File.new(pathname, pathname.read))
+          rescue StandardError => exception
+            Either::Left.new("Cannot read file: #{exception}")
+          end
+
+          def parse_pathname(input)
+            Either.wrap_error(ArgumentError) { Pathname.new(input) }
+              .lmap(&:message)
+          end
+        end # Mutation
+
+        SUBCOMMANDS = [Mutation].freeze
+      end # Util
+    end # Command
+  end # CLI
+end # Mutant

data/lib/mutant/cli/command.rb

@@ -69,6 +69,8 @@ module Mutant
         false
       end
 
+      abstract_method :action
+
     private
 
       def subcommands

data/lib/mutant/config.rb

@@ -10,6 +10,7 @@ module Mutant
       :coverage_criteria,
       :expression_parser,
       :fail_fast,
+      :hooks,
       :includes,
       :integration,
       :isolation,
@@ -49,11 +50,12 @@ module Mutant
       other.with(
         coverage_criteria: coverage_criteria.merge(other.coverage_criteria),
         fail_fast:         fail_fast || other.fail_fast,
+        hooks:             hooks + other.hooks,
         includes:          includes + other.includes,
-        jobs:              other.jobs || jobs,
         integration:       other.integration || integration,
-        mutation_timeout:  other.mutation_timeout || mutation_timeout,
+        jobs:              other.jobs || jobs,
         matcher:           matcher.merge(other.matcher),
+        mutation_timeout:  other.mutation_timeout || mutation_timeout,
         requires:          requires + other.requires,
         zombie:            zombie || other.zombie
       )
@@ -106,20 +108,30 @@ module Mutant
       DEFAULT.with(jobs: Etc.nprocessors)
     end
 
+    PATHNAME_ARRAY = Transform::Array.new(
+      Transform::Sequence.new(
+        [
+          Transform::STRING,
+          Transform::Exception.new(ArgumentError, Pathname.public_method(:new))
+        ]
+      )
+    )
+
     TRANSFORM = Transform::Sequence.new(
       [
         Transform::Exception.new(SystemCallError, :read.to_proc),
-        Transform::Exception.new(YAML::SyntaxError, YAML.method(:safe_load)),
+        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('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),
-            Transform::Hash::Key.new('matcher',           Matcher::Config::LOADER)
+            Transform::Hash::Key.new('requires',          Transform::STRING_ARRAY)
           ],
           required: []
         ),

data/lib/mutant/env.rb

@@ -5,6 +5,7 @@ module Mutant
   class Env
     include Adamantium, Anima.new(
       :config,
+      :hooks,
       :integration,
       :matchable_scopes,
       :mutations,
@@ -29,6 +30,7 @@ module Mutant
     def self.empty(world, config)
       new(
         config:           config,
+        hooks:            Hooks.empty,
         integration:      Integration::Null.new(
           expression_parser: config.expression_parser,
           world:             world
@@ -136,7 +138,9 @@ module Mutant
 
     def run_mutation_tests(mutation, tests)
       config.isolation.call(config.mutation_timeout) do
+        hooks.run(:mutation_insert_pre, mutation)
         result = mutation.insert(world.kernel)
+        hooks.run(:mutation_insert_post, mutation)
 
         if result.equal?(Loader::Result::VoidValue.instance)
           Result::Test::VoidValue.instance

data/lib/mutant/expression.rb

@@ -52,7 +52,7 @@ module Mutant
 
     def self.from_match(match)
       names = anima.attribute_names
-      new(Hash[names.zip(names.map(&match.public_method(:[])))])
+      new(names.zip(names.map(&match.public_method(:[]))).to_h)
     end
     private_class_method :from_match
 

data/lib/mutant/hooks.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Mutant
+  class Hooks
+    include Adamantium, Concord::Public.new(:map)
+
+    DEFAULTS = %i[
+      env_infection_pre
+      env_infection_post
+      mutation_insert_post
+      mutation_insert_pre
+    ].product([EMPTY_ARRAY]).to_h.transform_values(&:freeze).freeze
+
+    MESSAGE = 'Unknown hook %s'
+
+    private_constant(*constants(false))
+
+    class UnknownHook < RuntimeError; end
+
+    def self.assert_name(name)
+      fail UnknownHook, MESSAGE % name.inspect unless DEFAULTS.key?(name)
+      self
+    end
+
+    def self.empty
+      new(DEFAULTS)
+    end
+
+    def merge(other)
+      self.class.new(
+        other.map.merge(map) { |_key, new, old| (old + new).freeze }.freeze
+      )
+    end
+
+    def run(name, payload)
+      Hooks.assert_name(name)
+
+      map.fetch(name).each { |block| block.call(payload) }
+
+      self
+    end
+
+    class Builder
+      def initialize
+        @map = DEFAULTS.transform_values(&:dup)
+      end
+
+      def register(name, &block)
+        Hooks.assert_name(name)
+
+        @map.fetch(name) << block
+
+        self
+      end
+
+      def to_hooks
+        Hooks.new(@map.transform_values(&:freeze).freeze)
+      end
+    end # Builder
+
+    # rubocop:disable Security/Eval
+    def self.load_pathname(pathname)
+      hooks = Builder.new
+
+      binding.eval(pathname.read, pathname.to_s)
+
+      hooks.to_hooks
+    end
+    # rubocop:enable Security/Eval
+
+    def self.load_config(config)
+      config.hooks.reduce(empty) do |current, path|
+        current.merge(load_pathname(path))
+      end
+    end
+  end # Hooks
+end # Mutant

data/lib/mutant/matcher/config.rb

@@ -25,7 +25,7 @@ module Mutant
 
       private_constant(*constants(false))
 
-      DEFAULT = new(Hash[anima.attribute_names.map { |name| [name, []] }])
+      DEFAULT = new(anima.attribute_names.map { |name| [name, []] }.to_h)
 
       expression = Transform::Block.capture(:expression) do |input|
         Mutant::Config::DEFAULT.expression_parser.call(input)

data/lib/mutant/matcher/methods.rb

@@ -41,7 +41,7 @@ module Mutant
 
       def candidate_names
         CANDIDATE_NAMES
-          .map(&candidate_scope.method(:public_send))
+          .map(&candidate_scope.public_method(:public_send))
           .reduce(:+)
           .sort
       end

data/lib/mutant/mutation.rb

@@ -72,6 +72,15 @@ module Mutant
       )
     end
 
+    # Rendered mutation diff
+    #
+    # @return [String, nil]
+    #   the diff, if present
+    def diff
+      Unparser::Diff.build(original_source, source)
+    end
+    memoize :diff
+
   private
 
     def sha1
@@ -80,7 +89,6 @@ module Mutant
 
     # Evil mutation that should case mutations to fail tests
     class Evil < self
-
       SYMBOL            = 'evil'
       TEST_PASS_SUCCESS = false
 

data/lib/mutant/mutator.rb

@@ -4,7 +4,7 @@ module Mutant
   # Generator for mutations
   class Mutator
 
-    REGISTRY = Registry.new
+    REGISTRY = Registry.new(->(_) { Node::Generic })
 
     include(
       Adamantium,

data/lib/mutant/pipe.rb

@@ -57,6 +57,7 @@ module Mutant
 
           fail Error, 'message to big' if bytesize > MAX_BYTES
 
+          io.binmode
           io.write([bytesize].pack(HEADER_FORMAT))
           io.write(body)
         end
@@ -64,6 +65,7 @@ module Mutant
       private
 
         def read(bytes)
+          io.binmode
           io.read(bytes) or fail Error, 'Unexpected EOF'
         end
       end

data/lib/mutant/registry.rb

@@ -3,13 +3,13 @@
 module Mutant
   # Registry for mapping AST types to classes
   class Registry
-    include Concord.new(:contents)
+    include Concord.new(:contents, :default)
 
     # Initialize object
     #
     # @return [undefined]
-    def initialize
-      super({})
+    def initialize(default)
+      super({}, default)
     end
 
     # Raised when the type is an invalid type
@@ -34,7 +34,7 @@ module Mutant
     #
     # @return [Class<Mutator>]
     def lookup(type)
-      contents.fetch(type, Mutator::Node::Generic)
+      contents.fetch(type, &default)
     end
 
   end # Registry

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Mutant
+  class Reporter
+    class CLI
+      class Printer
+        # Reporter for mutations
+        class Mutation < self
+          NO_DIFF_MESSAGE = <<~'MESSAGE'
+            --- Internal failure ---
+            BUG: A generted mutation did not result in exactly one diff hunk!
+            This is an invariant violation by the mutation generation engine.
+            Please report a reproduction to https://github.com/mbj/mutant
+            Original unparsed source:
+            %s
+            Original AST:
+            %s
+            Mutated unparsed source:
+            %s
+            Mutated AST:
+            %s
+          MESSAGE
+
+          SEPARATOR = '-----------------------'
+
+          # Run report printer
+          #
+          # @return [undefined]
+          def run
+            diff = object.diff
+            diff = color? ? diff.colorized_diff : diff.diff
+
+            if diff
+              output.write(diff)
+            else
+              print_no_diff_message
+            end
+          end
+
+          def print_no_diff_message
+            info(
+              NO_DIFF_MESSAGE,
+              object.original_source,
+              original_node.inspect,
+              object.source,
+              object.node.inspect
+            )
+          end
+
+          def original_node
+            object.subject.node
+          end
+
+        end # MutationResult
+      end # Printer
+    end # CLI
+  end # Reporter
+end # Mutant

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

@@ -66,23 +66,7 @@ module Mutant
           end
 
           def evil_details
-            diff = Unparser::Diff.build(mutation.original_source, mutation.source)
-            diff = color? ? diff.colorized_diff : diff.diff
-            if diff
-              output.write(diff)
-            else
-              print_no_diff_message
-            end
-          end
-
-          def print_no_diff_message
-            info(
-              NO_DIFF_MESSAGE,
-              mutation.original_source,
-              original_node.inspect,
-              mutation.source,
-              mutation.node.inspect
-            )
+            visit(Mutation, mutation)
           end
 
           def noop_details
@@ -90,11 +74,7 @@ module Mutant
           end
 
           def neutral_details
-            info(NEUTRAL_MESSAGE, original_node.inspect, mutation.source)
-          end
-
-          def original_node
-            mutation.subject.node
+            info(NEUTRAL_MESSAGE, mutation.node.inspect, mutation.source)
           end
 
         end # MutationResult

data/lib/mutant/repository/diff.rb

@@ -98,7 +98,7 @@ module Mutant
         def diff_ranges
           world
             .capture_stdout(%W[git diff --unified=0 #{to} -- #{path}])
-            .fmap(&Ranges.method(:parse))
+            .fmap(&Ranges.public_method(:parse))
             .from_right
         end
         memoize :diff_ranges

data/lib/mutant/transform.rb

@@ -332,7 +332,7 @@ module Mutant
 
       def transform(input)
         transform_required(input).bind do |required|
-          transform_optional(input).fmap(&required.method(:merge))
+          transform_optional(input).fmap(&required.public_method(:merge))
         end
       end
 

data/lib/mutant/version.rb

@@ -2,5 +2,5 @@
 
 module Mutant
   # Current mutant version
-  VERSION = '0.10.29'
+  VERSION = '0.10.33'
 end # Mutant

data/lib/mutant.rb

@@ -186,6 +186,7 @@ require 'mutant/selector'
 require 'mutant/selector/expression'
 require 'mutant/selector/null'
 require 'mutant/world'
+require 'mutant/hooks'
 require 'mutant/config'
 require 'mutant/config/coverage_criteria'
 require 'mutant/cli'
@@ -196,6 +197,7 @@ require 'mutant/cli/command/environment/run'
 require 'mutant/cli/command/environment/show'
 require 'mutant/cli/command/environment/subject'
 require 'mutant/cli/command/environment/test'
+require 'mutant/cli/command/util'
 require 'mutant/cli/command/root'
 require 'mutant/runner'
 require 'mutant/runner/sink'
@@ -211,6 +213,7 @@ require 'mutant/reporter/cli/printer/env'
 require 'mutant/reporter/cli/printer/env_progress'
 require 'mutant/reporter/cli/printer/env_result'
 require 'mutant/reporter/cli/printer/isolation_result'
+require 'mutant/reporter/cli/printer/mutation'
 require 'mutant/reporter/cli/printer/mutation_result'
 require 'mutant/reporter/cli/printer/status_progressive'
 require 'mutant/reporter/cli/printer/subject_result'
@@ -257,6 +260,7 @@ module Mutant
         Expression::Namespace::Recursive
       ]),
       fail_fast:         false,
+      hooks:             EMPTY_ARRAY,
       includes:          EMPTY_ARRAY,
       integration:       nil,
       isolation:         Mutant::Isolation::Fork.new(WORLD),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mutant
 version: !ruby/object:Gem::Version
-  version: 0.10.29
+  version: 0.10.33
 platform: ruby
 authors:
 - Markus Schirp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -186,6 +186,7 @@ files:
 - lib/mutant/cli/command/environment/test.rb
 - lib/mutant/cli/command/root.rb
 - lib/mutant/cli/command/subscription.rb
+- lib/mutant/cli/command/util.rb
 - lib/mutant/config.rb
 - lib/mutant/config/coverage_criteria.rb
 - lib/mutant/context.rb
@@ -195,6 +196,7 @@ files:
 - lib/mutant/expression/methods.rb
 - lib/mutant/expression/namespace.rb
 - lib/mutant/expression/parser.rb
+- lib/mutant/hooks.rb
 - lib/mutant/integration.rb
 - lib/mutant/integration/null.rb
 - lib/mutant/isolation.rb
@@ -315,6 +317,7 @@ files:
 - lib/mutant/reporter/cli/printer/env_progress.rb
 - lib/mutant/reporter/cli/printer/env_result.rb
 - lib/mutant/reporter/cli/printer/isolation_result.rb
+- lib/mutant/reporter/cli/printer/mutation.rb
 - lib/mutant/reporter/cli/printer/mutation_result.rb
 - lib/mutant/reporter/cli/printer/status_progressive.rb
 - lib/mutant/reporter/cli/printer/subject_result.rb
@@ -363,7 +366,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: ''