mutant 0.9.6 → 0.9.11

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

@@ -35,18 +35,10 @@ module Mutant
 
         private
 
-          # Object being printed
-          #
-          # @return [Result::Env]
           def object
             super().payload
           end
 
-          # Mutations processed per second
-          #
-          # @return [Float]
-          #
-          # @api private
           def mutations_per_second
             amount_mutation_results / runtime
           end

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

@@ -32,9 +32,6 @@ module Mutant
 
         private
 
-          # Print stats
-          #
-          # @return [undefined]
           def print_stats
             status(
               FORMAT,
@@ -47,16 +44,10 @@ module Mutant
             )
           end
 
-          # Print progress bar finish
-          #
-          # @return [undefined]
           def print_progress_bar_finish
             puts(nil) unless amount_mutation_results.zero?
           end
 
-          # Print mutation results
-          #
-          # @return [undefined]
           def print_mutation_results
             visit_collection(MutationProgressResult, object.mutation_results)
           end

data/lib/mutant/repository/diff.rb

@@ -29,10 +29,6 @@ module Mutant
 
     private
 
-      # Touched paths
-      #
-      # @return [Hash{Pathname => Path}]
-      #
       # rubocop:disable Metrics/MethodLength
       def touched_paths
         pathname = world.pathname
@@ -49,13 +45,8 @@ module Mutant
           .to_h
       end
       memoize :touched_paths
+      # rubocop:enable Metrics/MethodLength
 
-      # Parse path
-      #
-      # @param [Pathname] work_dir
-      # @param [String] line
-      #
-      # @return [Path]
       def parse_line(work_dir, line)
         match = FORMAT.match(line) or fail Error, "Invalid git diff-index line: #{line}"
 
@@ -88,9 +79,6 @@ module Mutant
 
       private
 
-        # Ranges of hunks in the diff
-        #
-        # @return [Array<Range<Integer>>]
         def diff_ranges
           world
             .capture_stdout(%W[git diff --unified=0 #{to} -- #{path}])

data/lib/mutant/repository/diff/ranges.rb

@@ -18,11 +18,6 @@ module Mutant
           diff.lines.flat_map(&method(:parse_ranges)).to_set
         end
 
-        # Parse ranges from line
-        #
-        # @param [String] line
-        #
-        # @return [Array<Range<Integer>>]
         def self.parse_ranges(line)
           match = REGEXP.match(line) or return EMPTY_ARRAY
 
@@ -34,12 +29,6 @@ module Mutant
         end
         private_class_method :parse_ranges
 
-        # Construct a range from start point and offset
-        #
-        # @param [String] start
-        # @param [String, nil] offset
-        #
-        # @return [Range<Integer>]
         def self.mk_range(start, offset)
           start = Integer(start)
 

data/lib/mutant/result.rb

@@ -193,9 +193,6 @@ module Mutant
 
     private
 
-      # Killed mutation results
-      #
-      # @return [Array<Result::Mutation>]
       def killed_mutation_results
         mutation_results.select(&:success?)
       end

data/lib/mutant/runner.rb

@@ -12,9 +12,6 @@ module Mutant
       Either::Right.new(run_mutation_analysis(env))
     end
 
-    # Run mutation analysis
-    #
-    # @return [undefined]
     def self.run_mutation_analysis(env)
       reporter = reporter(env)
 
@@ -27,13 +24,6 @@ module Mutant
     end
     private_class_method :run_mutation_analysis
 
-    # Run driver
-    #
-    # @param [Reporter] reporter
-    # @param [Driver] driver
-    #
-    # @return [Object]
-    #   the last returned status payload
     def self.run_driver(reporter, driver)
       loop do
         status = driver.wait_timeout(reporter.delay)
@@ -43,9 +33,6 @@ module Mutant
     end
     private_class_method :run_driver
 
-    # Configuration for parallel execution engine
-    #
-    # @return [Parallell::Config]
     def self.mutation_test_config(env)
       world = env.world
 
@@ -61,11 +48,6 @@ module Mutant
     end
     private_class_method :mutation_test_config
 
-    # Reporter to use
-    #
-    # @param [Env] env
-    #
-    # @return [Reporter]
     def self.reporter(env)
       env.config.reporter
     end

data/lib/mutant/runner/sink.rb

@@ -51,11 +51,6 @@ module Mutant
 
     private
 
-      # Return previous results
-      #
-      # @param [Subject]
-      #
-      # @return [Array<Result::Mutation>]
       def previous_mutation_results(subject)
         subject_result = @subject_results.fetch(subject) { return EMPTY_ARRAY }
         subject_result.mutation_results

data/lib/mutant/subject.rb

@@ -79,18 +79,10 @@ module Mutant
 
   private
 
-    # Neutral mutation
-    #
-    # @return [Mutation::Neutral]
     def neutral_mutation
       Mutation::Neutral.new(self, wrap_node(node))
     end
 
-    # Wrap node into subject specific container
-    #
-    # @param [Parser::AST::Node] node
-    #
-    # @return [Parser::AST::Node]
     def wrap_node(node)
       node
     end

data/lib/mutant/subject/method.rb

@@ -34,9 +34,6 @@ module Mutant
 
     private
 
-      # The scope
-      #
-      # @return [Class, Module]
       def scope
         context.scope
       end

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

@@ -23,23 +23,57 @@ module Mutant
         class Memoized < self
           include AST::Sexp
 
+          FREEZER_OPTION_VALUES = {
+            Adamantium::Freezer::Deep => :deep,
+            Adamantium::Freezer::Flat => :flat,
+            Adamantium::Freezer::Noop => :noop
+          }.freeze
+
+          private_constant(*constants(false))
+
           # Prepare subject for mutation insertion
           #
           # @return [self]
           def prepare
-            scope.__send__(:memoized_methods).instance_variable_get(:@memory).delete(name)
+            memory.delete(name)
             super()
           end
 
         private
 
-          # Memoizer node for mutant
+          def wrap_node(mutant)
+            s(:begin, mutant, s(:send, nil, :memoize, s(:args, s(:sym, name), *options)))
+          end
+
+          # The optional AST node for adamantium memoization options
           #
-          # @param [Parser::AST::Node] mutant
+          # @return [Array(Parser::AST::Node), nil]
+          def options
+            # rubocop:disable Style/GuardClause
+            if FREEZER_OPTION_VALUES.key?(freezer)
+              [
+                s(:hash,
+                  s(:pair,
+                    s(:sym, :freezer),
+                    s(:sym, FREEZER_OPTION_VALUES.fetch(freezer))))
+              ]
+            end
+            # rubocop:enable Style/GuardClause
+          end
+
+          # The freezer used for memoization
           #
-          # @return [Parser::AST::Node]
-          def wrap_node(mutant)
-            s(:begin, mutant, s(:send, nil, :memoize, s(:args, s(:sym, name))))
+          # @return [Object]
+          def freezer
+            memory.fetch(name).instance_variable_get(:@freezer)
+          end
+          memoize :freezer, freezer: :noop
+
+          # The memory used for memoization
+          #
+          # @return [ThreadSafe::Cache]
+          def memory
+            scope.__send__(:memoized_methods).instance_variable_get(:@memory)
           end
 
         end # Memoized

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mutant
+  class Subject
+    class Method
+      # Singleton method defined using metaclass syntax
+      # (class << self; def foo; end; end)
+      class Metaclass < self
+        include AST::Sexp
+
+        NAME_INDEX = 0
+        SYMBOL     = '.'
+
+        # Prepare subject for mutation insertion
+        #
+        # @return [self]
+        def prepare
+          scope.singleton_class.public_send(:undef_method, name)
+          self
+        end
+
+      private
+
+        def wrap_node(mutant)
+          s(:sclass, AST::Nodes::N_SELF, mutant)
+        end
+      end # Metaclass
+    end # Method
+  end # Subject
+end # Mutant

data/lib/mutant/transform.rb

@@ -49,9 +49,6 @@ module Mutant
 
     private
 
-      # Path representation to error
-      #
-      # @return [String]
       def path
         trace.map { |error| error.transform.slug }.reject(&:empty?).join('/')
       end
@@ -78,23 +75,6 @@ module Mutant
 
   private
 
-    # Make error from curent context
-    #
-    # @param [Error, nil] cause
-    #   original error, if any
-    #
-    # @param [Object] input
-    #   input that ran into the error
-    #
-    # @param [String] message
-    #   human readable error message
-    #
-    # @param [Transform, nil]
-    #   transform that generated the error from input
-    #
-    # @return [Error]
-    #
-    # ignore :reek:LongParameterList
     def error(cause: nil, input:, message: nil)
       Error.new(
         cause:     cause,
@@ -104,42 +84,18 @@ module Mutant
       )
     end
 
-    # Lift error
-    #
-    # @param [Error]
-    #
-    # @return [Error]
     def lift_error(error)
       error.with(transform: self)
     end
 
-    # Wrap error
-    #
-    # @param [Error]
-    #
-    # @return [Error]
     def wrap_error(error)
       error(cause: error, input: error.input)
     end
 
-    # Create failure
-    #
-    # @param [Object] value
-    #
-    # @return [Either::Left]
-    #
-    # ignore :reek:UtilityFunction
     def failure(value)
       Either::Left.new(value)
     end
 
-    # Create success
-    #
-    # @param [Object] value
-    #
-    # @return [Either::Right]
-    #
-    # ignore :reek:UtilityFunction
     def success(value)
       Either::Right.new(value)
     end
@@ -268,14 +224,6 @@ module Mutant
 
     private
 
-      # Transform array
-      #
-      # @param [Array<Object>] input
-      #
-      # @return [Either<Error, Array<Object>]
-      #
-      # ignore :reek:NestedIterators
-      #
       # rubocop:disable Metrics/MethodLength
       def run(input)
         output = []
@@ -357,31 +305,16 @@ module Mutant
 
     private
 
-      # Transform hash
-      #
-      # @param [Hash] input
-      #
-      # @return [Either<Error, Hash>]
       def transform(input)
         transform_required(input).bind do |required|
           transform_optional(input).fmap(&required.method(:merge))
         end
       end
 
-      # Transform required keys
-      #
-      # @param [Hash] input
-      #
-      # @return [Either<Error, Hash>]
       def transform_required(input)
         transform_keys(required, input)
       end
 
-      # Transform optional keys
-      #
-      # @param [Hash] input
-      #
-      # @return [Either<Error, Hash>]
       def transform_optional(input)
         transform_keys(
           optional.select { |key| input.key?(key.value) },
@@ -389,13 +322,6 @@ module Mutant
         )
       end
 
-      # Transform keys
-      #
-      # @param [Array<Transform::Hash::Key>] keys
-      # @param [Hash] input
-      #
-      # @return [Either<Error, Hash>]
-      #
       # ignore :reek:NestedIterators
       #
       # rubocop:disable Metrics/MethodLength
@@ -415,24 +341,12 @@ module Mutant
       end
       # rubocop:enable Metrics/MethodLength
 
-      # Coerce key value under key specific transformer
-      #
-      # @param [Hash::Key] key
-      # @param [Hash] input
-      #
-      # @return [Either<Error, Object>]
       def coerce_key(key, input)
         key.apply(input.fetch(key.value)).lmap do |error|
           error(input: input, cause: error)
         end
       end
 
-      # Reject unexpected keys
-      #
-      # @param [Hash]
-      #
-      # @return [Either<Error, Object>]
-      #
       # rubocop:disable Metrics/MethodLength
       def reject_keys(input)
         keys       = input.keys
@@ -452,17 +366,11 @@ module Mutant
       end
       # rubocop:enable Metrics/MethodLength
 
-      # Key values allowed to be present
-      #
-      # @return [Array<Object>]
       def allowed_keys
         required_keys + optional.map(&:value)
       end
       memoize :allowed_keys
 
-      # Key values required to be present
-      #
-      # @return [Array<Object>]
       def required_keys
         required.map(&:value)
       end