Merge pull request #1021 from mbj/remove/yard-docs-for-private-methods

Remove yard docs for private methods

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
   ruby-mutant:
     name: Mutation coverage
     runs-on: ${{ matrix.os }}
-    timeout-minutes: 5
+    timeout-minutes: 30
     strategy:
       fail-fast: false
       matrix:
@@ -47,7 +47,7 @@ jobs:
     - run: |
         gem install bundler
         bundle install
-    - run: bundle exec mutant --since HEAD~1 --zombie -- 'Mutant*'
+    - run: ./mutant.sh
   ruby-integration-minitest:
     name: Integration Minitest
     runs-on: ${{ matrix.os }}

lib/mutant/ast.rb

@@ -27,15 +27,6 @@ def self.find_last_path(node, &predicate)
       path
     end
 
-    # Walk all ast nodes keeping track of path
-    #
-    # @param [Parser::AST::Node] root
-    # @param [Array<Parser::AST::Node>] stack
-    #
-    # @yield [Parser::AST::Node]
-    #   all nodes visited recursively including root
-    #
-    # @return [undefined]
     def self.walk(node, stack, &block)
       block.call(node, stack)
       node.children.grep(::Parser::AST::Node) do |child|

lib/mutant/ast/meta/send.rb

@@ -56,16 +56,10 @@ def receiver_possible_top_level_const?
 
       private
 
-        # Test if node is `proc { ... }`
-        #
-        # @return [Boolean]
         def naked_proc?
           !receiver && selector.equal?(:proc)
         end
 
-        # Test if node is `Proc.new { ... }`
-        #
-        # @return [Boolean]
         def proc_new?
           receiver                &&
             selector.equal?(:new) &&

lib/mutant/bootstrap.rb

@@ -49,9 +49,6 @@ def self.apply(world, config)
     end
     # rubocop:enable Metrics/MethodLength
 
-    # Infect environment
-    #
-    # @return [undefined]
     def self.infect(env)
       config, world = env.config, env.world
 
@@ -60,12 +57,6 @@ def self.infect(env)
     end
     private_class_method :infect
 
-    # Matchable scopes
-    #
-    # @param [World] world
-    # @param [Config] config
-    #
-    # @return [Array<Scope>]
     def self.matchable_scopes(world, config)
       scopes = world.object_space.each_object(Module).each_with_object([]) do |scope, aggregate|
         expression = expression(config.reporter, config.expression_parser, scope) || next
@@ -76,15 +67,6 @@ def self.matchable_scopes(world, config)
     end
     private_class_method :matchable_scopes
 
-    # Scope name from scoping object
-    #
-    # @param [Class, Module] scope
-    #
-    # @return [String]
-    #   if scope has a name and does not raise exceptions obtaining it
-    #
-    # @return [nil]
-    #   otherwise
     def self.scope_name(reporter, scope)
       scope.name
     rescue => exception
@@ -99,20 +81,7 @@ def self.scope_name(reporter, scope)
     end
     private_class_method :scope_name
 
-    # Try to turn scope into expression
-    #
-    # @param [Expression::Parser] expression_parser
-    # @param [Class, Module] scope
-    #
-    # @return [Expression]
-    #   if scope can be represented in an expression
-    #
-    # @return [nil]
-    #   otherwise
-    #
     # rubocop:disable Metrics/MethodLength
-    #
-    # ignore :reek:LongParameterList
     def self.expression(reporter, expression_parser, scope)
       name = scope_name(reporter, scope) or return
 
@@ -132,11 +101,6 @@ def self.expression(reporter, expression_parser, scope)
     private_class_method :expression
     # rubocop:enable Metrics/MethodLength
 
-    # Write a semantics warning
-    #
-    # @return [undefined]
-    #
-    # ignore :reek:LongParameterList
     def self.semantics_warning(reporter, format, options)
       reporter.warn(SEMANTICS_MESSAGE_FORMAT % { message: format % options })
     end

lib/mutant/cli.rb

@@ -88,23 +88,12 @@ def parse(arguments)
 
   private
 
-    # Parse matchers
-    #
-    # @param [Array<String>] expressions
-    #
-    # @return [undefined]
     def parse_match_expressions(expressions)
       expressions.each do |expression|
         add_matcher(:match_expressions, config.expression_parser.apply(expression).from_right)
       end
     end
 
-    # Add environmental options
-    #
-    # @param [Object] opts
-    #
-    # @return [undefined]
-    #
     # rubocop:disable Metrics/MethodLength
     def add_environment_options(opts)
       opts.separator('Environment:')
@@ -121,12 +110,8 @@ def add_environment_options(opts)
         with(jobs: Integer(number))
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
-    # Add mutation options
-    #
-    # @param [OptionParser] opts
-    #
-    # @return [undefined]
     def add_mutation_options(opts)
       opts.separator(nil)
       opts.separator('Options:')
@@ -136,11 +121,7 @@ def add_mutation_options(opts)
       end
     end
 
-    # Add filter options
-    #
-    # @param [OptionParser] opts
-    #
-    # @return [undefined]
+    # rubocop:disable Metrics/MethodLength
     def add_filter_options(opts)
       opts.on('--ignore-subject EXPRESSION', 'Ignore subjects that match EXPRESSION as prefix') do |pattern|
         add_matcher(:ignore_expressions, config.expression_parser.apply(pattern).from_right)
@@ -154,12 +135,9 @@ def add_filter_options(opts)
         )
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
-    # Add debug options
-    #
-    # @param [OptionParser] opts
-    #
-    # @return [undefined]
+    # rubocop:disable Metrics/MethodLength
     def add_debug_options(opts)
       opts.on('--fail-fast', 'Fail fast') do
         with(fail_fast: true)
@@ -173,38 +151,16 @@ def add_debug_options(opts)
         world.kernel.exit
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
-    # With configuration
-    #
-    # @param [Hash<Symbol, Object>] attributes
-    #
-    # @return [undefined]
     def with(attributes)
       @config = config.with(attributes)
     end
 
-    # Add configuration
-    #
-    # @param [Symbol] attribute
-    #   the attribute to add to
-    #
-    # @param [Object] value
-    #   the value to add
-    #
-    # @return [undefined]
     def add(attribute, value)
       with(attribute => config.public_send(attribute) + [value])
     end
 
-    # Add matcher configuration
-    #
-    # @param [Symbol] attribute
-    #   the attribute to add to
-    #
-    # @param [Object] value
-    #   the value to add
-    #
-    # @return [undefined]
     def add_matcher(attribute, value)
       with(matcher: config.matcher.add(attribute, value))
     end

lib/mutant/color.rb

@@ -28,9 +28,6 @@ def format(text)
 
     private
 
-      # Initialize null color
-      #
-      # @return [undefined]
       def initialize; end
 
     end.new

lib/mutant/config.rb

@@ -126,14 +126,6 @@ def self.load_config_file(world, config)
       end
     end
 
-    # Load contents of file
-    #
-    # @param [Pathname] path
-    #
-    # @return [Config]
-    #
-    # @raise [Either<String, Hash{Symbol => Object}>]
-    #   in case of config file error
     def self.load_contents(path)
       Transform::Named
         .new(path.to_s, TRANSFORM)

lib/mutant/context.rb

@@ -81,9 +81,6 @@ def match_expressions
 
   private
 
-    # Nesting of names in scope
-    #
-    # @return [Array<String>]
     def name_nesting
       scope.name.split(NAMESPACE_DELIMITER)
     end

lib/mutant/diff.rb

@@ -58,25 +58,16 @@ def self.lines(source)
 
   private
 
-    # Diffs between old and new
-    #
-    # @return [Array<Array>]
     def diffs
       ::Diff::LCS.diff(old, new)
     end
 
-    # Raw diff-lcs hunks
-    #
-    # @return [Array<Diff::LCS::Hunk>]
     def hunks
       diffs.map do |diff|
         ::Diff::LCS::Hunk.new(old.map(&:dup), new, diff, max_length, 0)
       end
     end
 
-    # Minimized hunk
-    #
-    # @return Diff::LCS::Hunk
     def minimized_hunk
       head, *tail = hunks
 
@@ -86,18 +77,10 @@ def minimized_hunk
       end
     end
 
-    # Max length of source line in new and old
-    #
-    # @return [Integer]
     def max_length
       [old, new].map(&:length).max
     end
 
-    # Colorized a unified diff line
-    #
-    # @param [String] line
-    #
-    # @return [String]
     def self.colorize_line(line)
       case line[0]
       when ADDITION

lib/mutant/env.rb

@@ -126,12 +126,6 @@ def test_subject_ratio
 
   private
 
-    # Kill mutation under isolation with integration
-    #
-    # @param [Mutation] mutation
-    # @param [Array<Test>] test
-    #
-    # @return [Result::Isolation]
     def run_mutation_tests(mutation, tests)
       config.isolation.call do
         result = mutation.insert(world.kernel)

lib/mutant/expression/method.rb

@@ -46,9 +46,6 @@ def matcher
 
     private
 
-      # Scope object
-      #
-      # @return [Class, Method]
       def scope
         Object.const_get(scope_name)
       end

lib/mutant/expression/methods.rb

@@ -50,9 +50,6 @@ def match_length(expression)
 
     private
 
-      # Scope object
-      #
-      # @return [Class, Method]
       def scope
         Object.const_get(scope_name)
       end

lib/mutant/expression/parser.rb

@@ -28,12 +28,6 @@ def apply(input)
 
     private
 
-      # Expressions parsed from input
-      #
-      # @param [String] input
-      #
-      # @return [Array<Expression>]
-      #   if expressions can be parsed from input
       def expressions(input)
         types.each_with_object([]) do |type, aggregate|
           expression = type.try_parse(input) and aggregate << expression

lib/mutant/integration.rb

@@ -32,14 +32,6 @@ def self.setup(env)
         .fmap { |klass| klass.new(env.config).setup }
     end
 
-    # Attempt to require integration
-    #
-    # @param env [Bootstrap]
-    #
-    # @return [Either<String, undefined>]
-    #
-    # @api private
-    #
     # rubocop:disable Style/MultilineBlockChain
     def self.attempt_require(env)
       integration_name = env.config.integration
@@ -56,13 +48,6 @@ def self.attempt_require(env)
     private_class_method :attempt_require
     # rubocop:enable Style/MultilineBlockChain
 
-    # Attempt const get
-    #
-    # @param env [Boostrap]
-    #
-    # @return [Either<String, Class<Integration>>]
-    #
-    # @api private
     def self.attempt_const_get(env)
       integration_name = env.config.integration
       constant_name    = integration_name.capitalize
@@ -98,9 +83,6 @@ def setup
 
   private
 
-    # Expression parser
-    #
-    # @return [Expression::Parser]
     def expression_parser
       config.expression_parser
     end