Add support for ignoring :nodoc: methods

Adds new `NodocMethods` option in rules:

- `Typing/MethodReturnTypeRestriction`
- `Typing/MethodParameterTypeRestriction`

spec/ameba/rule/typing/method_parameter_type_restriction_spec.cr

@@ -57,6 +57,13 @@ module Ameba::Rule::Typing
         CRYSTAL
     end
 
+    it "passes if a method has a `:nodoc:` annotation" do
+      expect_no_issues subject, <<-CRYSTAL
+        # :nodoc:
+        def foo(bar); end
+        CRYSTAL
+    end
+
     it "fails if a public method parameter doesn't have a type restriction" do
       expect_issue subject, <<-CRYSTAL
         def hello(a)
@@ -195,6 +202,20 @@ module Ameba::Rule::Typing
             CRYSTAL
         end
       end
+
+      context "#nodoc_methods" do
+        rule = MethodParameterTypeRestriction.new
+        rule.nodoc_methods = true
+
+        it "fails if a public method parameter doesn't have a type restriction" do
+          expect_issue rule, <<-CRYSTAL
+            # :nodoc:
+            def foo(bar)
+                  # ^ error: Method parameter should have a type restriction
+            end
+            CRYSTAL
+        end
+      end
     end
   end
 end

spec/ameba/rule/typing/method_return_type_restriction_spec.cr

@@ -32,6 +32,13 @@ module Ameba::Rule::Typing
         CRYSTAL
     end
 
+    it "passes if a method has a `:nodoc:` annotation" do
+      expect_no_issues subject, <<-CRYSTAL
+        # :nodoc:
+        def foo; end
+        CRYSTAL
+    end
+
     it "fails if a public method doesn't have a return type restriction" do
       expect_issue subject, <<-CRYSTAL
         def hello
@@ -119,6 +126,20 @@ module Ameba::Rule::Typing
             CRYSTAL
         end
       end
+
+      context "#nodoc_methods" do
+        rule = MethodReturnTypeRestriction.new
+        rule.nodoc_methods = true
+
+        it "fails if a public method doesn't have a return type restriction" do
+          expect_issue rule, <<-CRYSTAL
+            # :nodoc:
+            def foo
+            # ^^^^^ error: Method should have a return type restriction
+            end
+            CRYSTAL
+        end
+      end
     end
   end
 end

src/ameba/rule/typing/method_parameter_type_restriction.cr

@@ -49,8 +49,11 @@ module Ameba::Rule::Typing
   #   BlockParameters: false
   #   PrivateMethods: false
   #   ProtectedMethods: false
+  #   NodocMethods: false
   # ```
   class MethodParameterTypeRestriction < Base
+    include AST::Util
+
     properties do
       since_version "1.7.0"
       description "Recommends that method parameters have type restrictions"
@@ -59,6 +62,7 @@ module Ameba::Rule::Typing
       block_parameters false
       private_methods false
       protected_methods false
+      nodoc_methods false
     end
 
     MSG = "Method parameter should have a type restriction"
@@ -80,7 +84,8 @@ module Ameba::Rule::Typing
 
     private def valid_visibility?(node : Crystal::ASTNode) : Bool
       (!private_methods? && node.visibility.private?) ||
-        (!protected_methods? && node.visibility.protected?)
+        (!protected_methods? && node.visibility.protected?) ||
+        (!nodoc_methods? && nodoc?(node))
     end
   end
 end

src/ameba/rule/typing/method_return_type_restriction.cr

@@ -27,14 +27,18 @@ module Ameba::Rule::Typing
   #   Enabled: true
   #   PrivateMethods: false
   #   ProtectedMethods: false
+  #   NodocMethods: false
   # ```
   class MethodReturnTypeRestriction < Base
+    include AST::Util
+
     properties do
       since_version "1.7.0"
       description "Recommends that methods have a return type restriction"
       enabled false
       private_methods false
       protected_methods false
+      nodoc_methods false
     end
 
     MSG = "Method should have a return type restriction"
@@ -46,7 +50,8 @@ module Ameba::Rule::Typing
     private def valid_return_type?(node : Crystal::ASTNode) : Bool
       !!node.return_type ||
         (node.visibility.private? && !private_methods?) ||
-        (node.visibility.protected? && !protected_methods?)
+        (node.visibility.protected? && !protected_methods?) ||
+        (!nodoc_methods? && nodoc?(node))
     end
   end
 end