mutant 0.8.0 → 0.8.1

data/lib/mutant/matcher/methods.rb

@@ -13,7 +13,6 @@ module Mutant
       #   otherwise
       #
       # @api private
-      #
       def each(&block)
         return to_enum unless block_given?
 
@@ -22,22 +21,22 @@ module Mutant
         self
       end
 
-      # Return method matcher class
+    private
+
+      # method matcher class
       #
       # @return [Class:Matcher::Method]
       #
       # @api private
-      #
       def matcher
         self.class::MATCHER
       end
 
-      # Return methods
+      # Available methods scope
       #
       # @return [Enumerable<Method, UnboundMethod>]
       #
       # @api private
-      #
       def methods
         candidate_names.each_with_object([]) do |name, methods|
           method = access(name)
@@ -46,14 +45,11 @@ module Mutant
       end
       memoize :methods
 
-    private
-
-      # Return subjects
+      # Subjects detected on scope
       #
       # @return [Array<Subject>]
       #
       # @api private
-      #
       def subjects
         methods.map do |method|
           matcher.build(env, scope, method)
@@ -61,12 +57,11 @@ module Mutant
       end
       memoize :subjects
 
-      # Return candidate names
+      # Candidate method names on target scope
       #
       # @return [Enumerable<Symbol>]
       #
       # @api private
-      #
       def candidate_names
         (
           candidate_scope.public_instance_methods(false)   +
@@ -75,12 +70,11 @@ module Mutant
         ).sort
       end
 
-      # Return candidate scope
+      # Candidate scope
       #
       # @return [Class, Module]
       #
       # @api private
-      #
       abstract_method :candidate_scope
 
       # Matcher for singleton methods
@@ -89,24 +83,22 @@ module Mutant
 
       private
 
-        # Return method for name
+        # Method object on scope
         #
         # @param [Symbol] method_name
         #
         # @return [Method]
         #
         # @api private
-        #
         def access(method_name)
           scope.method(method_name)
         end
 
-        # Return candidate scope
+        # Candidate scope
         #
         # @return [Class]
         #
         # @api private
-        #
         def candidate_scope
           scope.singleton_class
         end
@@ -120,24 +112,22 @@ module Mutant
 
       private
 
-        # Return method for name
+        # Method object on scope
         #
         # @param [Symbol] method_name
         #
         # @return [UnboundMethod]
         #
         # @api private
-        #
         def access(method_name)
           scope.instance_method(method_name)
         end
 
-        # Return candidate scope
+        # Candidate scope
         #
         # @return [Class, Module]
         #
         # @api private
-        #
         def candidate_scope
           scope
         end

data/lib/mutant/matcher/namespace.rb

@@ -2,8 +2,6 @@ module Mutant
   class Matcher
 
     # Matcher for specific namespace
-    #
-    # rubocop:disable LineLength
     class Namespace < self
       include Concord::Public.new(:env, :expression)
 
@@ -16,7 +14,6 @@ module Mutant
       #   otherwise
       #
       # @api private
-      #
       def each(&block)
         return to_enum unless block_given?
 
@@ -36,7 +33,6 @@ module Mutant
       # @return [Boolean]
       #
       # @api private
-      #
       def match?(scope)
         expression.prefix?(scope.expression)
       end

data/lib/mutant/matcher/null.rb

@@ -13,7 +13,6 @@ module Mutant
       #   otherwise
       #
       # @api private
-      #
       def each
         return to_enum unless block_given?
         self

data/lib/mutant/matcher/scope.rb

@@ -9,17 +9,6 @@ module Mutant
         Matcher::Methods::Instance
       ].freeze
 
-      # Return identification
-      #
-      # @return [String]
-      #
-      # @api private
-      #
-      def identification
-        scope.name
-      end
-      memoize :identification
-
       # Enumerate subjects
       #
       # @return [self]
@@ -29,7 +18,6 @@ module Mutant
       #   otherwise
       #
       # @api private
-      #
       def each(&block)
         return to_enum unless block_given?
 

data/lib/mutant/meta.rb

@@ -14,7 +14,6 @@ module Mutant
       # @return [undefined]
       #
       # @api private
-      #
       def self.add(&block)
         file = caller.first.split(':in', 2).first
         ALL << DSL.run(file, block)

data/lib/mutant/meta/example.rb

@@ -3,33 +3,30 @@ module Mutant
     class Example
       include Adamantium, Concord::Public.new(:file, :node, :mutations)
 
-      # Return a verification instance
+      # Verification instance for example
       #
       # @return [Verification]
       #
       # @api private
-      #
       def verification
         Verification.new(self, generated)
       end
 
-      # Return source
+      # Normalized source
       #
       # @return [String]
       #
       # @api private
-      #
       def source
         Unparser.unparse(node)
       end
       memoize :source
 
-      # Return generated mutations
+      # Generated mutations on example source
       #
       # @return [Enumerable<Mutant::Mutation>]
       #
       # @api private
-      #
       def generated
         Mutator.each(node).map do |node|
           Mutation::Evil.new(self, node)
@@ -46,17 +43,15 @@ module Mutant
         # @return [Boolean]
         #
         # @api private
-        #
         def success?
           unparser.success? && missing.empty? && unexpected.empty? && no_diffs.empty?
         end
 
-        # Return error report
+        # Error report
         #
         # @return [String]
         #
         # @api private
-        #
         def error_report
           unless unparser.success?
             return unparser.report
@@ -66,34 +61,31 @@ module Mutant
 
       private
 
-        # Return unexpected mutations
+        # Unexpected mutations
         #
         # @return [Array<Parser::AST::Node>]
         #
         # @api private
-        #
         def unexpected
           mutations.map(&:node) - example.mutations
         end
         memoize :unexpected
 
-        # Return mutations with no diff to original
+        # Mutations with no diff to original
         #
         # @return [Enumerable<Mutation>]
         #
         # @api private
-        #
         def no_diffs
           mutations.select { |mutation| mutation.source.eql?(example.source) }
         end
         memoize :no_diffs
 
-        # Return mutation report
+        # Mutation report
         #
         # @return [String]
         #
         # @api private
-        #
         def mutation_report
           original_node = example.node
           [
@@ -107,12 +99,11 @@ module Mutant
           ].join("\n======\n")
         end
 
-        # Return missing report
+        # Missing mutation report
         #
         # @return [Array, nil]
         #
         # @api private
-        #
         def missing_report
           [
             'Missing mutations:',
@@ -120,12 +111,11 @@ module Mutant
           ] if missing.any?
         end
 
-        # Return no diff report
+        # No diff mutation report
         #
         # @return [Array, nil]
         #
         # @api private
-        #
         def no_diff_report
           [
             'No source diffs to original:',
@@ -135,12 +125,11 @@ module Mutant
           ] if no_diffs.any?
         end
 
-        # Return unexpected report
+        # Unexpected mutation report
         #
         # @return [Array, nil]
         #
         # @api private
-        #
         def unexpected_report
           [
             'Unexpected mutations:',
@@ -153,7 +142,6 @@ module Mutant
         # @return [String]
         #
         # @api private
-        #
         def format_mutation(node)
           [
             node.inspect,
@@ -161,23 +149,21 @@ module Mutant
           ].join("\n")
         end
 
-        # Return missing mutations
+        # Missing mutations
         #
         # @return [Array<Parser::AST::Node>]
         #
         # @api private
-        #
         def missing
           example.mutations - mutations.map(&:node)
         end
         memoize :missing
 
-        # Return unparser verifier
+        # Unparser verifier
         #
         # @return [Unparser::CLI::Source]
         #
         # @api private
-        #
         def unparser
           Unparser::CLI::Source::Node.new(Unparser::Preprocessor.run(example.node))
         end

data/lib/mutant/meta/example/dsl.rb

@@ -11,7 +11,6 @@ module Mutant
         # @return [Example]
         #
         # @api private
-        #
         def self.run(file, block)
           instance = new(file)
           instance.instance_eval(&block)
@@ -23,14 +22,13 @@ module Mutant
         # @return [undefined]
         #
         # @api private
-        #
         def initialize(file)
           @file = file
           @source = nil
           @expected = []
         end
 
-        # Return example
+        # Example captured by DSL
         #
         # @return [Example]
         #
@@ -38,7 +36,6 @@ module Mutant
         #   in case example cannot be build
         #
         # @api private
-        #
         def example
           fail 'source not defined' unless @source
           Example.new(@file, @source, @expected)
@@ -53,7 +50,6 @@ module Mutant
         # @return [self]
         #
         # @api private
-        #
         def source(input)
           fail 'source already defined' if @source
           @source = node(input)
@@ -68,7 +64,6 @@ module Mutant
         # @return [self]
         #
         # @api private
-        #
         def mutation(input)
           node = node(input)
           if @expected.include?(node)
@@ -84,7 +79,6 @@ module Mutant
         # @return [undefined]
         #
         # @api private
-        #
         def singleton_mutations
           mutation('nil')
           mutation('self')
@@ -100,7 +94,6 @@ module Mutant
         #   in case input cannot be coerced
         #
         # @api private
-        #
         def node(input)
           case input
           when String

data/lib/mutant/mutation.rb

@@ -7,45 +7,41 @@ module Mutant
     CODE_DELIMITER = "\0".freeze
     CODE_RANGE     = (0..4).freeze
 
-    # Return identification
+    # Identification string
     #
     # @return [String]
     #
     # @api private
-    #
     def identification
       "#{self.class::SYMBOL}:#{subject.identification}:#{code}"
     end
     memoize :identification
 
-    # Return mutation code
+    # Mutation code
     #
     # @return [String]
     #
     # @api private
-    #
     def code
       sha1[CODE_RANGE]
     end
     memoize :code
 
-    # Return source
+    # Normalized mutation source
     #
     # @return [String]
     #
     # @api private
-    #
     def source
       Unparser.unparse(node)
     end
     memoize :source
 
-    # Return original source
+    # Normalized original source
     #
     # @return [String]
     #
     # @api private
-    #
     def original_source
       subject.source
     end
@@ -57,7 +53,6 @@ module Mutant
     # @return [Boolean]
     #
     # @api private
-    #
     def self.success?(test_result)
       self::TEST_PASS_SUCCESS.equal?(test_result.passed)
     end
@@ -71,7 +66,6 @@ module Mutant
     # @return [self]
     #
     # @api private
-    #
     def insert
       subject.public?
       subject.prepare
@@ -81,23 +75,21 @@ module Mutant
 
   private
 
-    # Return sha1 sum of source and subject identification
+    # SHA1 sum of source and subject identification
     #
     # @return [String]
     #
     # @api private
-    #
     def sha1
       Digest::SHA1.hexdigest(subject.identification + CODE_DELIMITER + source)
     end
     memoize :sha1
 
-    # Return mutated root node
+    # Mutated root node
     #
     # @return [Parser::AST::Node]
     #
     # @api private
-    #
     def root
       subject.context.root(node)
     end