Merge pull request #23 from sue445/fix_meaning_less_error

Fix `comparison of Integer with nil failed` in `YARD/MeaninglessTag`

Rakefile

@@ -19,7 +19,8 @@ namespace :smoke do
       { name: "tag_type_syntax" }
     ],
     'YARD/MeaninglessTag' => [
-      { name: "meaningless_tag" }
+      { name: "meaningless_tag" },
+      { name: "meaningless_tag_n_plus_one_query" },
     ],
     'YARD/MismatchName' => [
       { name: "mismatch_name", correct: true }

lib/rubocop/cop/yard/helper.rb

@@ -78,7 +78,7 @@ def inline_comment?(comment)
 
         def build_docstring(preceding_lines)
           comment_texts = preceding_lines.map { |l| l.text.gsub(/\A#/, '') }
-          minimum_space = comment_texts.map { |t| t.index(/[^\s]/) }.min
+          minimum_space = comment_texts.map { |t| t.index(/[^\s]/) }.compact.min
           yard_docstring = comment_texts.map { |t| t[minimum_space..-1] }.join("\n")
           begin
             ::YARD::DocstringParser.new.parse(yard_docstring)

smoke/generated/meaningless_tag_n_plus_one_query.json

@@ -0,0 +1,20 @@
+{
+  "metadata": {
+    "rubocop_version": "1.57.2",
+    "ruby_engine": "ruby",
+    "ruby_version": "3.2.2",
+    "ruby_patchlevel": "53",
+    "ruby_platform": "arm64-darwin22"
+  },
+  "files": [
+    {
+      "path": "smoke/meaningless_tag_n_plus_one_query.rb",
+      "offenses": []
+    }
+  ],
+  "summary": {
+    "offense_count": 0,
+    "target_file_count": 1,
+    "inspected_file_count": 1
+  }
+}

smoke/meaningless_tag_n_plus_one_query.rb

@@ -0,0 +1,44 @@
+# Checks that there’s no N+1 query
+#
+# @note If `Database` isn't configured, auto-correct will not be available. (Only offense detection can be used)
+#
+# @note For the number of N+1 queries that can be detected by this cop, there are too few that can be corrected automatically
+#
+# @example
+#   # bad
+#   reservations = db.xquery('SELECT * FROM `reservations` WHERE `schedule_id` = ?', schedule_id).map do |reservation|
+#     reservation[:user] = db.xquery('SELECT * FROM `users` WHERE `id` = ? LIMIT 1', id).first
+#     reservation
+#   end
+#
+#   # good
+#   rows = db.xquery(<<~SQL, schedule_id)
+#     SELECT
+#       r.id AS reservation_id,
+#       r.schedule_id AS reservation_schedule_id,
+#       r.user_id AS reservation_user_id,
+#       r.created_at AS reservation_created_at,
+#       u.id AS user_id,
+#       u.email AS user_email,
+#       u.nickname AS user_nickname,
+#       u.staff AS user_staff,
+#       u.created_at AS user_created_at
+#     FROM `reservations` AS r
+#     INNER JOIN users u ON u.id = r.user_id
+#     WHERE r.schedule_id = ?
+#   SQL
+#
+#   # bad
+#   courses.map do |course|
+#     teacher = db.xquery('SELECT * FROM `users` WHERE `id` = ?', course[:teacher_id]).first
+#   end
+#
+#   # good
+#   # This is similar to ActiveRecord's preload
+#   # c.f. https://guides.rubyonrails.org/active_record_querying.html#preload
+#   courses.map do |course|
+#     @users_by_id ||= db.xquery('SELECT * FROM `users` WHERE `id` IN (?)', courses.map { |course| course[:teacher_id] }).each_with_object({}) { |v, hash| hash[v[:id]] = v }
+#     teacher = @users_by_id[course[:teacher_id]]
+#   end
+class NPlusOneQuery < Base
+end