Merge pull request #110 from koic/add_required_ruby_version_to_cops_m…

…anual Add required Ruby version to generated cops manual
rubocop · May 21, 2020 · cbee419 · cbee419
2 parents 31aa377 + c9b34c2
commit cbee419
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/manual/cops_performance.md b/manual/cops_performance.md
@@ -2,6 +2,10 @@
 
 ## Performance/BindCall
 
+!!! Note
+
+    Required Ruby version: 2.7
+
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 1.6 | -
@@ -253,6 +257,10 @@ Model.select(:value).count
 
 ## Performance/DeletePrefix
 
+!!! Note
+
+    Required Ruby version: 2.5
+
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 1.6 | -
@@ -281,6 +289,10 @@ str.delete_prefix!('prefix')
 
 ## Performance/DeleteSuffix
 
+!!! Note
+
+    Required Ruby version: 2.5
+
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 --- | --- | --- | --- | ---
 Enabled | Yes | Yes  | 1.6 | -

diff --git a/tasks/cops_documentation.rake b/tasks/cops_documentation.rake
@@ -17,6 +17,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def cops_body(config, cop, description, examples_objects, pars)
     content = h2(cop.cop_name)
+    content << required_ruby_version(cop)
     content << properties(config, cop)
     content << "#{description}\n"
     content << examples(examples_objects) if examples_objects.count.positive?
@@ -32,6 +33,17 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     end
   end
 
+  def required_ruby_version(cop)
+    return '' unless cop.respond_to?(:required_minimum_ruby_version)
+
+    <<~NOTE
+      !!! Note
+
+          Required Ruby version: #{cop.required_minimum_ruby_version}
+
+    NOTE
+  end
+
   # rubocop:disable Metrics/MethodLength
   def properties(config, cop)
     header = [