no_comments 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5bc4347ee7e47373f8375ffe9c6e699726d61bc86bbafffce828f1c3ded8a8d
-  data.tar.gz: b9b155b4dd1b5d4a9bb1bbec8bb01e4a61298f7203497cd3b88bf9dae9828524
+  metadata.gz: c98d97eb96221297ef0ef1b6140abd04ac9a54ce759fdfd46b0708497b223022
+  data.tar.gz: 42a109143ae3b1ab99a176e625a74dbe350d878838eb40b93c5f483f13428f11
 SHA512:
-  metadata.gz: 6c54ac24a9e4788546a9eba6d74d919729ae154f0dc8ee4a75e6318562f0f8c04f12955116dce1ed05f56375f6181935e215618aca66450108be29725b3b4648
-  data.tar.gz: dbc1757abfacb2af495446321110afe2f62e0c9f68135528f725fc2464e4e7e2898c58094e0a403c933a82cb4caea1222b6929e9b6e097c105e2cf5017779ed4
+  metadata.gz: 82418111acf7d4de92b39c52cd6bafb32959b1ae024836d53a7be3a2b66257cd13299e4b179f84506012debc71db3c48bcbade705e6df0cb18b7a83fa09cc550
+  data.tar.gz: 01df35d37bc0e4200beb1c15c6b4f2846d2904faa681d20706e218681999e7f4e946ef7df0eab2ede035f415b095d784d06e37ffed15062dc5cbae206e52d510

data/README.md

@@ -13,6 +13,7 @@ It preserves:
 - Shebangs (e.g., #!/usr/bin/env ruby)
 - Magic comments (e.g., # frozen_string_literal: true)
 - Tool-defined comments (e.g., # rubocop:disable all)
+- Documentation comments (e.g., # @param id)
 
 ## Table of Contents
 1. [When to Use This Gem](#When-to-Use-This-Gem)
@@ -112,6 +113,12 @@ no_comments -p path/to/file.rb --audit
 no_comments -p path/to/directory --audit
 ```
 
+#### Preserve Documentation Comments
+```bash
+no_comments -p path/to/file.rb --keep-doc-comments
+no_comments -p path/to/directory --keep-doc-comments
+```
+
 ## Testing
 
 This gem uses RSpec for testing. To run tests:
@@ -152,10 +159,6 @@ Please ensure your code follows the existing style and that all tests pass befor
 This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## TODO
-Planned features for future updates:
-- **Option to Keep Documentation Comments:**
-  - Preserve comments like # @param or # @return for tools like YARD.
-  Reference: [RuboCop documentation cop](https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/Documentation).
 - **Selective Cleaning:**
   - Allow users to clean all files in a directory except for specified ones.
 

data/exe/no_comments

@@ -15,11 +15,15 @@ OptionParser.new do |opts|
   opts.on("--audit", "Run in audit mode to display comments without modifying files") do
     options[:audit] = true
   end
+
+  opts.on("-d", "--keep-doc-comments", "Preserve documentation comments like @param") do
+    options[:keep_doc_comments] = true
+  end
 end.parse!
 
 if options[:path]
   begin
-    NoComments::Remover.clean(options[:path], audit: options[:audit])
+    NoComments::Remover.clean(options[:path], audit: options[:audit], keep_doc_comments: options[:keep_doc_comments])
     if options[:audit]
       puts "Audit completed successfully."
     else

data/lib/no_comments/comment_detector.rb

@@ -4,6 +4,7 @@ module NoComments
   module CommentDetector
     MAGIC_COMMENT_REGEX = /\A#.*\b(?:frozen_string_literal|encoding|coding|warn_indent|fileencoding)\b.*\z/
     TOOL_COMMENT_REGEX = /\A#\s*(?:rubocop|reek|simplecov|coveralls|pry|byebug|noinspection|sorbet|type)\b/
+    DOC_COMMENT_REGEX = /\A#\s*@\w+/
     def magic_comment?(stripped_line)
       stripped_line.match?(MAGIC_COMMENT_REGEX)
     end
@@ -11,5 +12,9 @@ module NoComments
     def tool_comment?(stripped_line)
       stripped_line.match?(TOOL_COMMENT_REGEX)
     end
+
+    def documentation_comment?(stripped_line)
+      stripped_line.match?(DOC_COMMENT_REGEX)
+    end
   end
 end

data/lib/no_comments/content_processor.rb

@@ -7,7 +7,7 @@ module NoComments
   class ContentProcessor
     include CommentDetector
     include LineParser
-    def initialize
+    def initialize(keep_doc_comments: false)
       @comments = []
       @result_lines = []
       @in_multiline_comment = false
@@ -15,6 +15,7 @@ module NoComments
       @heredoc_delimiter = nil
       @line_number = 0
       @code_started = false
+      @keep_doc_comments = keep_doc_comments
     end
 
     def process(content)
@@ -45,17 +46,21 @@ module NoComments
       if stripped_line.empty? || stripped_line.start_with?("#!") || magic_comment?(stripped_line)
         @result_lines << line.rstrip
       elsif stripped_line.start_with?("#")
-        if tool_comment?(stripped_line)
-          @result_lines << line.rstrip
-        else
-          @comments << [@line_number, stripped_line]
-        end
+        handle_initial_comment_line(line, stripped_line)
       else
         @code_started = true
         handle_regular_line(line, stripped_line)
       end
     end
 
+    def handle_initial_comment_line(line, stripped_line)
+      if tool_comment?(stripped_line) || (@keep_doc_comments && documentation_comment?(stripped_line))
+        @result_lines << line.rstrip
+      else
+        @comments << [@line_number, stripped_line]
+      end
+    end
+
     def handle_multiline_comment(stripped_line)
       @comments << [@line_number, stripped_line]
       @in_multiline_comment = false if stripped_line == "=end"
@@ -73,7 +78,9 @@ module NoComments
         start_multiline_comment(stripped_line)
       elsif (heredoc_start = detect_heredoc_start(line))
         start_heredoc(line, heredoc_start)
-      elsif stripped_line.start_with?("#") && tool_comment?(stripped_line)
+      elsif stripped_line.start_with?("#") &&
+            (tool_comment?(stripped_line) ||
+             (@keep_doc_comments && documentation_comment?(stripped_line)))
         @result_lines << line.rstrip
       else
         process_code_line(line)
@@ -95,10 +102,15 @@ module NoComments
       code_part, comment_part = split_line(line)
       return handle_empty_line(line) if code_part.strip.empty? && comment_part.nil?
       return handle_tool_comment_line(code_part, comment_part) if comment_part && tool_comment?(comment_part.strip)
+      return handle_doc_comment_line(code_part, comment_part) if keep_doc_comment?(comment_part)
 
       handle_regular_code_line(code_part, comment_part)
     end
 
+    def keep_doc_comment?(comment_part)
+      comment_part && @keep_doc_comments && documentation_comment?(comment_part.strip)
+    end
+
     private
 
     def handle_empty_line(line)
@@ -109,6 +121,10 @@ module NoComments
       @result_lines << ("#{code_part.rstrip} #{comment_part.strip}")
     end
 
+    def handle_doc_comment_line(code_part, comment_part)
+      @result_lines << ("#{code_part.rstrip} #{comment_part.strip}")
+    end
+
     def handle_regular_code_line(code_part, comment_part)
       @comments << [@line_number, comment_part.strip] if comment_part
       return if code_part.strip.empty?

data/lib/no_comments/remover.rb

@@ -4,20 +4,20 @@ require "no_comments/version"
 require "no_comments/content_processor"
 module NoComments
   class Remover
-    def self.clean(file_path, audit: false)
+    def self.clean(file_path, audit: false, keep_doc_comments: false)
       if File.directory?(file_path)
         Dir.glob("#{file_path}/**/*.rb").each do |file|
-          process_file(file, audit: audit)
+          process_file(file, audit: audit, keep_doc_comments: keep_doc_comments)
         end
       else
-        process_file(file_path, audit: audit)
+        process_file(file_path, audit: audit, keep_doc_comments: keep_doc_comments)
       end
     end
 
-    def self.process_file(file_path, audit: false)
+    def self.process_file(file_path, audit: false, keep_doc_comments: false)
       validate_file_extension(file_path)
       content = File.read(file_path)
-      processor = ContentProcessor.new
+      processor = ContentProcessor.new(keep_doc_comments: keep_doc_comments)
       cleaned_content, comments = processor.process(content)
       if audit
         print_audit(file_path, comments)

data/lib/no_comments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NoComments
-  VERSION = "0.1.10"
+  VERSION = "0.1.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: no_comments
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Justyna