mutant 0.8.8 → 0.8.9

data/lib/mutant/matcher/filter.rb

@@ -6,11 +6,9 @@ module Mutant
 
       # Enumerate matches
       #
-      # @param [Env] env
+      # @param [Env::Bootstrap] env
       #
       # @return [Enumerable<Subject>]
-      #
-      # @api private
       def call(env)
         matcher
           .call(env)

data/lib/mutant/matcher/method.rb

@@ -18,11 +18,9 @@ module Mutant
 
       # Matched subjects
       #
-      # @param [Env] env
+      # @param [Env::Bootstrap] env
       #
       # @return [Enumerable<Subject>]
-      #
-      # @api private
       def call(env)
         evaluator.call(scope, target_method, env)
       end
@@ -30,7 +28,7 @@ module Mutant
       # Abstract method match evaluator
       #
       # Present to avoid passing the env argument around in case the
-      # logic would be implemnented directly on the Matcher::Method
+      # logic would be implemented directly on the Matcher::Method
       # instance
       class Evaluator
         include AbstractType,
@@ -42,8 +40,6 @@ module Mutant
         # Matched subjects
         #
         # @return [Enumerable<Subject>]
-        #
-        # @api private
         def call
           return EMPTY_ARRAY if skip?
 
@@ -55,8 +51,6 @@ module Mutant
         # Test if method should be skipped
         #
         # @return [Truthy]
-        #
-        # @api private
         def skip?
           location = source_location
           if location.nil? || BLACKLIST.match(location.first)
@@ -69,8 +63,6 @@ module Mutant
         # Target method name
         #
         # @return [String]
-        #
-        # @api private
         def method_name
           target_method.name
         end
@@ -78,8 +70,6 @@ module Mutant
         # Target context
         #
         # @return [Context::Scope]
-        #
-        # @api private
         def context
           Context::Scope.new(scope, source_path)
         end
@@ -87,27 +77,21 @@ module Mutant
         # Root source node
         #
         # @return [Parser::AST::Node]
-        #
-        # @api private
         def ast
-          env.cache.parse(source_path)
+          env.parser.call(source_path)
         end
 
         # Path to source
         #
         # @return [Pathname]
-        #
-        # @api private
         def source_path
-          Pathname.new(source_location.first)
+          env.config.pathname.new(source_location.first)
         end
         memoize :source_path
 
         # Source file line
         #
         # @return [Fixnum]
-        #
-        # @api private
         def source_line
           source_location.last
         end
@@ -115,8 +99,6 @@ module Mutant
         # Full source location
         #
         # @return [Array{String,Fixnum}]
-        #
-        # @api private
         def source_location
           target_method.source_location
         end
@@ -128,8 +110,6 @@ module Mutant
         #
         # @return [nil]
         #   otherwise
-        #
-        # @api private
         def subject
           node = matched_node_path.last || return
           self.class::SUBJECT_CLASS.new(context, node)
@@ -139,8 +119,6 @@ module Mutant
         # Matched node path
         #
         # @return [Array<Parser::AST::Node>]
-        #
-        # @api private
         def matched_node_path
           AST.find_last_path(ast, &method(:match?))
         end

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

@@ -10,8 +10,6 @@ module Mutant
         # @param [UnboundMethod] method
         #
         # @return [Matcher::Method::Instance]
-        #
-        # @api private
         def self.new(scope, target_method)
           name = target_method.name
           evaluator =
@@ -36,15 +34,13 @@ module Mutant
           # @param [Parser::AST::Node] node
           #
           # @return [Boolean]
-          #
-          # @api private
           def match?(node)
             n_def?(node)                           &&
             node.location.line.equal?(source_line) &&
             node.children.fetch(NAME_INDEX).equal?(method_name)
           end
 
-          # Evaluator specialized for memoized instance mthods
+          # Evaluator specialized for memoized instance methods
           class Memoized < self
             SUBJECT_CLASS = Subject::Method::Instance::Memoized
 
@@ -53,8 +49,6 @@ module Mutant
             # Source location
             #
             # @return [Array{String,Fixnum}]
-            #
-            # @api private
             def source_location
               scope
                 .unmemoized_instance_method(method_name)

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

@@ -10,8 +10,6 @@ module Mutant
         # @param [Symbol] method_name
         #
         # @return [Matcher::Method::Singleton]
-        #
-        # @api private
         def self.new(scope, method_name)
           super(scope, method_name, Evaluator)
         end
@@ -29,8 +27,6 @@ module Mutant
           # @param [Parser::AST::Node] node
           #
           # @return [Boolean]
-          #
-          # @api private
           def match?(node)
             n_defs?(node) && line?(node) && name?(node) && receiver?(node)
           end
@@ -40,8 +36,6 @@ module Mutant
           # @param [Parser::AST::Node] node
           #
           # @return [Boolean]
-          #
-          # @api private
           def line?(node)
             node
               .location
@@ -54,8 +48,6 @@ module Mutant
           # @param [Parser::AST::Node] node
           #
           # @return [Boolean]
-          #
-          # @api private
           def name?(node)
             node.children.fetch(NAME_INDEX).equal?(method_name)
           end
@@ -65,8 +57,6 @@ module Mutant
           # @param [Parser::AST::Node] node
           #
           # @return [Boolean]
-          #
-          # @api private
           def receiver?(node)
             receiver = node.children.fetch(RECEIVER_INDEX)
             case receiver.type
@@ -85,8 +75,6 @@ module Mutant
           # @param [Parser::AST::Node] node
           #
           # @return [Boolean]
-          #
-          # @api private
           def receiver_name?(node)
             name = node.children.fetch(NAME_INDEX)
             name.to_s.eql?(context.unqualified_name)

data/lib/mutant/matcher/methods.rb

@@ -14,11 +14,9 @@ module Mutant
 
       # Enumerate subjects
       #
-      # @param [Env] env
+      # @param [Env::Bootstrap] env
       #
       # @return [Enumerable<Subject>]
-      #
-      # @api private
       def call(env)
         Chain.new(
           methods.map { |method| matcher.new(scope, method) }
@@ -30,8 +28,6 @@ module Mutant
       # method matcher class
       #
       # @return [Class:Matcher::Method]
-      #
-      # @api private
       def matcher
         self.class::MATCHER
       end
@@ -39,8 +35,6 @@ module Mutant
       # Available methods scope
       #
       # @return [Enumerable<Method, UnboundMethod>]
-      #
-      # @api private
       def methods
         candidate_names.each_with_object([]) do |name, methods|
           method = access(name)
@@ -52,8 +46,6 @@ module Mutant
       # Candidate method names on target scope
       #
       # @return [Enumerable<Symbol>]
-      #
-      # @api private
       def candidate_names
         CANDIDATE_NAMES
           .map(&candidate_scope.method(:public_send))
@@ -64,8 +56,6 @@ module Mutant
       # Candidate scope
       #
       # @return [Class, Module]
-      #
-      # @api private
       abstract_method :candidate_scope
 
       # Matcher for singleton methods
@@ -79,8 +69,6 @@ module Mutant
         # @param [Symbol] method_name
         #
         # @return [Method]
-        #
-        # @api private
         def access(method_name)
           scope.method(method_name)
         end
@@ -88,8 +76,6 @@ module Mutant
         # Candidate scope
         #
         # @return [Class]
-        #
-        # @api private
         def candidate_scope
           scope.singleton_class
         end
@@ -108,8 +94,6 @@ module Mutant
         # @param [Symbol] method_name
         #
         # @return [UnboundMethod]
-        #
-        # @api private
         def access(method_name)
           scope.instance_method(method_name)
         end
@@ -117,8 +101,6 @@ module Mutant
         # Candidate scope
         #
         # @return [Class, Module]
-        #
-        # @api private
         def candidate_scope
           scope
         end

data/lib/mutant/matcher/namespace.rb

@@ -6,11 +6,9 @@ module Mutant
 
       # Enumerate subjects
       #
-      # @param [Env] env
+      # @param [Env::Bootstrap] env
       #
       # @return [Enumerable<Subject>]
-      #
-      # @api private
       def call(env)
         Chain.new(
           matched_scopes(env).map { |scope| Scope.new(scope.raw) }
@@ -24,8 +22,6 @@ module Mutant
       # @param [Env] env
       #
       # @return [Enumerable<Scope>]
-      #
-      # @api private
       def matched_scopes(env)
         env
           .matchable_scopes
@@ -37,8 +33,6 @@ module Mutant
       # @param [Scope] scope
       #
       # @return [Boolean]
-      #
-      # @api private
       def match?(scope)
         expression.prefix?(scope.expression)
       end

data/lib/mutant/matcher/null.rb

@@ -6,11 +6,9 @@ module Mutant
 
       # Enumerate subjects
       #
-      # @param [Env] env
+      # @param [Env::Bootstrap] env
       #
       # @return [Enumerable<Subject>]
-      #
-      # @api private
       def call(_env)
         EMPTY_ARRAY
       end

data/lib/mutant/matcher/scope.rb

@@ -18,11 +18,9 @@ module Mutant
 
       # Matched subjects
       #
-      # @param [Env] env
+      # @param [Env::Bootstrap] env
       #
       # @return [Enumerable<Subject>]
-      #
-      # @api private
       def call(env)
         Chain.new(effective_matchers).call(env)
       end
@@ -32,8 +30,6 @@ module Mutant
       # Effective matchers
       #
       # @return [Enumerable<Matcher>]
-      #
-      # @api private
       def effective_matchers
         MATCHERS.map { |matcher| matcher.new(scope) }
       end

data/lib/mutant/matcher/static.rb

@@ -7,8 +7,6 @@ module Mutant
       # Call matcher
       #
       # @return [Enumerable<Subject>]
-      #
-      # @api private
       def call(_env)
         subjects
       end

data/lib/mutant/meta.rb

@@ -12,8 +12,6 @@ module Mutant
       # Add example
       #
       # @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

@@ -6,8 +6,6 @@ module Mutant
       # Verification instance for example
       #
       # @return [Verification]
-      #
-      # @api private
       def verification
         Verification.new(self, generated)
       end
@@ -15,8 +13,6 @@ module Mutant
       # Normalized source
       #
       # @return [String]
-      #
-      # @api private
       def source
         Unparser.unparse(node)
       end
@@ -25,8 +21,6 @@ module Mutant
       # Generated mutations on example source
       #
       # @return [Enumerable<Mutant::Mutation>]
-      #
-      # @api private
       def generated
         Mutator.each(node).map do |node|
           Mutation::Evil.new(self, node)
@@ -41,8 +35,6 @@ module Mutant
         # Test if mutation was verified successfully
         #
         # @return [Boolean]
-        #
-        # @api private
         def success?
           unparser.success? && missing.empty? && unexpected.empty? && no_diffs.empty?
         end
@@ -50,8 +42,6 @@ module Mutant
         # Error report
         #
         # @return [String]
-        #
-        # @api private
         def error_report
           unless unparser.success?
             return unparser.report
@@ -64,8 +54,6 @@ module Mutant
         # Unexpected mutations
         #
         # @return [Array<Parser::AST::Node>]
-        #
-        # @api private
         def unexpected
           mutations.map(&:node) - example.mutations
         end
@@ -74,8 +62,6 @@ module Mutant
         # Mutations with no diff to original
         #
         # @return [Enumerable<Mutation>]
-        #
-        # @api private
         def no_diffs
           mutations.select { |mutation| mutation.source.eql?(example.source) }
         end
@@ -84,8 +70,6 @@ module Mutant
         # Mutation report
         #
         # @return [String]
-        #
-        # @api private
         def mutation_report
           original_node = example.node
           [
@@ -102,8 +86,6 @@ module Mutant
         # Missing mutation report
         #
         # @return [Array, nil]
-        #
-        # @api private
         def missing_report
           [
             'Missing mutations:',
@@ -114,8 +96,6 @@ module Mutant
         # No diff mutation report
         #
         # @return [Array, nil]
-        #
-        # @api private
         def no_diff_report
           [
             'No source diffs to original:',
@@ -128,8 +108,6 @@ module Mutant
         # Unexpected mutation report
         #
         # @return [Array, nil]
-        #
-        # @api private
         def unexpected_report
           [
             'Unexpected mutations:',
@@ -140,8 +118,6 @@ module Mutant
         # Format mutation
         #
         # @return [String]
-        #
-        # @api private
         def format_mutation(node)
           [
             node.inspect,
@@ -152,8 +128,6 @@ module Mutant
         # Missing mutations
         #
         # @return [Array<Parser::AST::Node>]
-        #
-        # @api private
         def missing
           example.mutations - mutations.map(&:node)
         end
@@ -162,8 +136,6 @@ module Mutant
         # Unparser verifier
         #
         # @return [Unparser::CLI::Source]
-        #
-        # @api private
         def unparser
           Unparser::CLI::Source::Node.new(Unparser::Preprocessor.run(example.node))
         end