mutant 0.9.8 → 0.9.9

data/lib/mutant/mutator/node.rb

@@ -34,21 +34,9 @@ module Mutant
 
     private
 
-      # Node to mutate
-      #
-      # @return [Parser::AST::Node]
-      alias_method :node, :input
-
-      # Duplicate of original
-      #
-      # @return [Parser::AST::Node]
+      alias_method :node,     :input
       alias_method :dup_node, :dup_input
 
-      # Dispatch on child index
-      #
-      # @param [Integer] index
-      #
-      # @return [undefined]
       def mutate_child(index, &block)
         block ||= TAUTOLOGY
         Mutator.mutate(children.fetch(index), self).each do |mutation|
@@ -57,108 +45,55 @@ module Mutant
         end
       end
 
-      # Emit delete child mutation
-      #
-      # @param [Integer] index
-      #
-      # @return [undefined]
       def delete_child(index)
         dup_children = children.dup
         dup_children.delete_at(index)
         emit_type(*dup_children)
       end
 
-      # Emit updated child
-      #
-      # @param [Integer] index
-      # @param [Parser::AST::Node] node
-      #
-      # @return [undefined]
       def emit_child_update(index, node)
         new_children = children.dup
         new_children[index] = node
         emit_type(*new_children)
       end
 
-      # Emit a new AST node with same class as wrapped node
-      #
-      # @param [Array<Parser::AST::Node>] children
-      #
-      # @return [undefined]
       def emit_type(*children)
         emit(::Parser::AST::Node.new(node.type, children))
       end
 
-      # Emit propagation if node can stand alone
-      #
-      # @return [undefined]
       def emit_propagation(node)
         emit(node) unless AST::Types::NOT_STANDALONE.include?(node.type)
       end
 
-      # Emit singleton literals
-      #
-      # @return [undefined]
       def emit_singletons
         emit_nil
         emit_self
       end
 
-      # Emit a literal self
-      #
-      # @return [undefined]
       def emit_self
         emit(N_SELF)
       end
 
-      # Emit a literal nil
-      #
-      # @return [undefined]
       def emit_nil
         emit(N_NIL) unless left_assignment?
       end
 
-      # Parent node
-      #
-      # @return [Parser::AST::Node] node
-      #   if parent with node is present
-      #
-      # @return [nil]
-      #   otherwise
       def parent_node
         parent&.node
       end
 
-      # Parent type
-      #
-      # @return [Symbol] type
-      #   if parent with type is present
-      #
-      # @return [nil]
-      #   otherwise
       def parent_type
         parent_node&.type
       end
 
-      # Test if the node is the left of an or_asgn or op_asgn
-      #
-      # @return [Boolean]
       def left_assignment?
         AST::Types::OP_ASSIGN.include?(parent_type) && parent.node.children.first.equal?(node)
       end
 
-      # Children indices
-      #
-      # @param [Range] range
-      #
-      # @return [Enumerable<Integer>]
       def children_indices(range)
         range.begin.upto(children.length + range.end)
       end
 
-      # Emit single child mutation
-      #
-      # @return [undefined]
       def mutate_single_child
         children.each_with_index do |child, index|
           mutate_child(index)

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

@@ -13,9 +13,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_singletons
           emit_left_mutations do |node|

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

@@ -14,24 +14,15 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_name_mutation
         end
 
-        # Emit name mutations
-        #
-        # @return [undefined]
         def emit_name_mutation
           return if skip?
           emit_name(:"#{UNDERSCORE}#{name}")
         end
 
-        # Test if argument mutation is skipped
-        #
-        # @return [Boolean]
         def skip?
           name.to_s.start_with?(UNDERSCORE)
         end
@@ -50,18 +41,12 @@ module Mutant
 
         private
 
-          # Emit mutations
-          #
-          # @return [undefined]
           def dispatch
             emit_name_mutation
             emit_required_mutation
             emit_default_mutations
           end
 
-          # Emit required mutation
-          #
-          # @return [undefined]
           def emit_required_mutation
             emit(s(TYPE_MAP.fetch(node.type), name))
           end

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

@@ -12,18 +12,12 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_argument_presence
           emit_argument_mutations
           emit_mlhs_expansion
         end
 
-        # Emit argument presence mutation
-        #
-        # @return [undefined]
         def emit_argument_presence
           emit_type
 
@@ -34,9 +28,6 @@ module Mutant
           end
         end
 
-        # Emit argument mutations
-        #
-        # @return [undefined]
         def emit_argument_mutations
           children.each_with_index do |child, index|
             Mutator.mutate(child).each do |mutant|
@@ -46,18 +37,10 @@ module Mutant
           end
         end
 
-        # Test if child mutation is allowed
-        #
-        # @param [Parser::AST::Node]
-        #
-        # @return [Boolean]
         def invalid_argument_replacement?(mutant, index)
           n_arg?(mutant) && children[0...index].any?(&method(:n_optarg?))
         end
 
-        # Emit mlhs expansions
-        #
-        # @return [undefined]
         def emit_mlhs_expansion
           mlhs_childs_with_index.each do |child, index|
             dup_children = children.dup
@@ -67,9 +50,6 @@ module Mutant
           end
         end
 
-        # Multiple left hand side childs
-        #
-        # @return [Enumerable<Parser::AST::Node, Integer>]
         def mlhs_childs_with_index
           children.each_with_index.select do |child,|
             n_mlhs?(child)

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

@@ -11,9 +11,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           mutate_single_child do |child|
             emit(child)

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

@@ -17,9 +17,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_singletons
           emit_promotions
@@ -29,35 +26,15 @@ module Mutant
           emit_right_mutations
         end
 
-        # Emit operator mutations
-        #
-        # @return [undefined]
         def emit_operator_mutations
           emit(s(INVERSE.fetch(node.type), left, right))
         end
 
-        # Emit promotions
-        #
-        # @return [undefined]
         def emit_promotions
           emit(left)
           emit(right)
         end
 
-        # Emit left negation
-        #
-        # We do not emit right negation as the `and` and `or` nodes
-        # in ruby are also used for control flow.
-        #
-        # Irrespective of their syntax, aka `||` parses internally to `or`.
-        #
-        # `do_a or do_b`. Negating left makes sense, negating right
-        # only when the result is actually used.
-        #
-        # It *would* be possible to emit the right negation in case the use of the result is proved.
-        # Like parent is an assignment to an {l,i}var. Dunno if we ever get the time to do that.
-        #
-        # @return [undefined]
         def emit_left_negation
           emit(s(node.type, n_not(left), right))
         end

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

@@ -11,9 +11,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_singletons
           emit(send) unless n_lambda?(send)
@@ -23,9 +20,6 @@ module Mutant
           mutate_body
         end
 
-        # Emit body mutations
-        #
-        # @return [undefined]
         def mutate_body
           emit_body(nil)
           emit_body(N_RAISE)
@@ -37,18 +31,12 @@ module Mutant
           mutate_body_receiver
         end
 
-        # Test if body has control structures
-        #
-        # @return [Boolean]
         def body_has_control?
           AST.find_last_path(body) do |node|
             n_break?(node) || n_next?(node)
           end.any?
         end
 
-        # Mutate method send in body scope of `send`
-        #
-        # @return [undefined]
         def mutate_body_receiver
           return if n_lambda?(send) || !n_send?(body)
 
@@ -57,9 +45,6 @@ module Mutant
           emit(s(:send, send, body_meta.selector, *body_meta.arguments))
         end
 
-        # Test for valid send mutations
-        #
-        # @return [true, false, nil]
         def valid_send_mutation?(node)
           return unless n_send?(node)
 

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

@@ -11,9 +11,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           super()
           emit_singletons

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

@@ -13,9 +13,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_singletons
           emit_condition_mutations if condition
@@ -23,9 +20,6 @@ module Mutant
           emit_else_mutations
         end
 
-        # Emit when mutations
-        #
-        # @return [undefined]
         def emit_when_mutations
           indices = children.each_index.drop(1).take(children.length - 2)
           one = indices.one?
@@ -35,9 +29,6 @@ module Mutant
           end
         end
 
-        # Emit else mutations
-        #
-        # @return [undefined]
         def emit_else_mutations
           else_branch = children.last
           else_index = children.length - 1

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

@@ -11,9 +11,6 @@ module Mutant
 
       private
 
-        # Emit mutations only for class body
-        #
-        # @return [undefined]
         def dispatch
           emit_body_mutations if body
         end

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

@@ -13,9 +13,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_singletons
           emit_condition_mutations

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

@@ -11,9 +11,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_singletons unless parent_node && n_const?(parent_node)
           emit_type(nil, *children.drop(1))

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

@@ -8,9 +8,6 @@ module Mutant
 
       private
 
-        # Emit mutations
-        #
-        # @return [undefined]
         def dispatch
           emit_arguments_mutations
           emit_optarg_body_assignments
@@ -20,9 +17,6 @@ module Mutant
           emit_body_mutations if body
         end
 
-        # Emit mutations with optional arguments as assignments in method
-        #
-        # @return [undefined]
         def emit_optarg_body_assignments
           arguments.children.each do |argument|
             next unless n_optarg?(argument) && AST::Meta::Optarg.new(argument).used?
@@ -31,11 +25,6 @@ module Mutant
           end
         end
 
-        # Emit valid body ASTs depending on instance body
-        #
-        # @param node [Parser::AST::Node]
-        #
-        # @return [undefined]
         def emit_body_prepend(node)
           if body
             emit_body(s(:begin, node, body))