no_comments 0.1.10 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5bc4347ee7e47373f8375ffe9c6e699726d61bc86bbafffce828f1c3ded8a8d
-  data.tar.gz: b9b155b4dd1b5d4a9bb1bbec8bb01e4a61298f7203497cd3b88bf9dae9828524
+  metadata.gz: e8b64729d21c62f938c510fe179a75bdd4e642336830f043e37852351fe2f7e7
+  data.tar.gz: 5e36dc7b0751f92f6dba54b42e4f1b89d8612a2ac15e236dbe362e09152b51e5
 SHA512:
-  metadata.gz: 6c54ac24a9e4788546a9eba6d74d919729ae154f0dc8ee4a75e6318562f0f8c04f12955116dce1ed05f56375f6181935e215618aca66450108be29725b3b4648
-  data.tar.gz: dbc1757abfacb2af495446321110afe2f62e0c9f68135528f725fc2464e4e7e2898c58094e0a403c933a82cb4caea1222b6929e9b6e097c105e2cf5017779ed4
+  metadata.gz: 86877162d04e05f36347fb23b9259064e44acae9b0e9bda4411af13884195b023e909ffbf57dca41b04dfe371ef748d663db22c4fcefd5336d0a3e691addaf58
+  data.tar.gz: 0bd8e85a51c4d495aacfa42d8c1c7c755064116761fd56e2a46cc53b14a298bfae65399027daf31dc93a537a5ff64e52bf88f9414be67a10efb91ccac6510a7c

data/AGENTS.md

@@ -0,0 +1,48 @@
+# Instructions
+- The user will provide a task.
+- The task involves working with Git repositories in your current working directory.
+- Wait for all terminal commands to be completed (or terminate them) before finishing.
+
+# Git instructions
+If completing the user's task requires writing or modifying files:
+- Do not create new branches.
+- Use git to commit your changes.
+- If pre-commit fails, fix issues and retry.
+- Check git status to confirm your commit. You must leave your worktree in a clean state.
+- Only committed code will be evaluated.
+- Do not modify or amend existing commits.
+
+# AGENTS.md spec
+- Containers often contain AGENTS.md files. These files can appear anywhere in the container's filesystem. Typical locations include `/`, `~`, and in various places inside of Git repos.
+- These files are a way for humans to give you (the agent) instructions or tips for working within the container.
+- Some examples might be: coding conventions, info about how code is organized, or instructions for how to run or test code.
+- AGENTS.md files may provide instructions about PR messages (messages attached to a GitHub Pull Request produced by the agent, describing the PR). These instructions should be respected.
+- Instructions in AGENTS.md files:
+  - The scope of an AGENTS.md file is the entire directory tree rooted at the folder that contains it.
+  - For every file you touch in the final patch, you must obey instructions in any AGENTS.md file whose scope includes that file.
+  - Instructions about code style, structure, naming, etc. apply only to code within the AGENTS.md file's scope, unless the file states otherwise.
+  - More-deeply-nested AGENTS.md files take precedence in the case of conflicting instructions.
+  - Direct system/developer/user instructions (as part of a prompt) take precedence over AGENTS.md instructions.
+- AGENTS.md files need not live only in Git repos. For example, you may find one in your home directory.
+- If the AGENTS.md includes programmatic checks to verify your work, you MUST run all of them and make a best effort to validate that the checks pass AFTER all code changes have been made.
+  - This applies even for changes that appear simple, i.e. documentation. You still must run all of the programmatic checks.
+
+# Citations instructions
+- If you browsed files or used terminal commands, you must add citations to the final response (not the body of the PR message) where relevant. Citations reference file paths and terminal outputs with the following formats:
+  1) `F:<file_path>†L<line_start>(-L<line_end>)?`
+  - File path citations must start with `F:`. `file_path` is the exact file path of the file relative to the root of the repository that contains the relevant text.
+  - `line_start` is the 1-indexed start line number of the relevant output within that file.
+  2) `<chunk_id>†L<line_start>(-L<line_end>)?`
+  - Where chunk_id is the chunk_id of the terminal output, line_start and line_end are the 1-indexed start and end line numbers of the relevant output within that chunk.
+- Line ends are optional, and if not provided, line end is the same as line start, so only 1 line is cited.
+- Ensure that the line numbers are correct, and that the cited file paths or terminal outputs are directly relevant to the word or clause before the citation.
+- Do not cite completely empty lines inside the chunk, only cite lines that have content.
+- Only cite from file paths and terminal outputs, DO NOT cite from previous pr diffs and comments, nor cite git hashes as chunk ids.
+- Use file path citations that reference any code changes, documentation or files, and use terminal citations only for relevant terminal output.
+- Prefer file citations over terminal citations unless the terminal output is directly relevant to the clauses before the citation, i.e. clauses on test results.
+  - For PR creation tasks, use file citations when referring to code changes in the summary section of your final response, and terminal citations in the testing section.
+  - For question-answering tasks, you should only use terminal citations if you need to programmatically verify an answer (i.e. counting lines of code). Otherwise, use file citations.
+
+Add the crucial information that the branch name should be written in english if not please translate it into english.
+
+Before commit run 'bundle exec rspec' 'bundle exec bundler-audit --update' and 'bundle exec rubocop --parallel' and the next fix the problems if appear

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,9 @@ 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+/
+    NODOC_STRING = ":nodoc:"
+    CLASS_OR_MODULE_REGEX = /\A(?:class|module)\b/
     def magic_comment?(stripped_line)
       stripped_line.match?(MAGIC_COMMENT_REGEX)
     end
@@ -11,5 +14,13 @@ module NoComments
     def tool_comment?(stripped_line)
       stripped_line.match?(TOOL_COMMENT_REGEX)
     end
+
+    def documentation_comment?(stripped_line, next_line = nil)
+      return true if stripped_line.match?(DOC_COMMENT_REGEX)
+      return true if stripped_line.include?(NODOC_STRING)
+      return true if next_line&.match?(CLASS_OR_MODULE_REGEX)
+
+      false
+    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,44 +15,50 @@ module NoComments
       @heredoc_delimiter = nil
       @line_number = 0
       @code_started = false
+      @keep_doc_comments = keep_doc_comments
     end
 
     def process(content)
       lines = content.lines
-      lines.each do |line|
-        @line_number += 1
+      lines.each_with_index do |line, index|
+        @line_number = index + 1
         stripped_line = line.strip
-        process_line(line, stripped_line)
+        next_line = next_non_comment_line(lines, index)
+        process_line(line, stripped_line, next_line)
       end
       cleaned_content = @result_lines.join("\n")
       cleaned_content += "\n" unless cleaned_content.empty?
       [cleaned_content, @comments]
     end
 
-    def process_line(line, stripped_line)
+    def process_line(line, stripped_line, next_line)
       if @in_multiline_comment
         handle_multiline_comment(stripped_line)
       elsif @in_heredoc
         handle_heredoc(line, stripped_line)
       elsif !@code_started
-        handle_initial_lines(line, stripped_line)
+        handle_initial_lines(line, stripped_line, next_line)
       else
-        handle_regular_line(line, stripped_line)
+        handle_regular_line(line, stripped_line, next_line)
       end
     end
 
-    def handle_initial_lines(line, stripped_line)
+    def handle_initial_lines(line, stripped_line, next_line)
       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, next_line)
       else
         @code_started = true
-        handle_regular_line(line, stripped_line)
+        handle_regular_line(line, stripped_line, next_line)
+      end
+    end
+
+    def handle_initial_comment_line(line, stripped_line, next_line)
+      if tool_comment?(stripped_line) || (@keep_doc_comments && documentation_comment?(stripped_line, next_line&.strip))
+        @result_lines << line.rstrip
+      else
+        @comments << [@line_number, stripped_line]
       end
     end
 
@@ -68,17 +74,21 @@ module NoComments
       )
     end
 
-    def handle_regular_line(line, stripped_line)
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def handle_regular_line(line, stripped_line, next_line)
       if stripped_line == "=begin"
         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, next_line&.strip)))
         @result_lines << line.rstrip
       else
         process_code_line(line)
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def start_multiline_comment(stripped_line)
       @in_multiline_comment = true
@@ -95,12 +105,30 @@ 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 next_non_comment_line(lines, index)
+      j = index + 1
+      while j < lines.length
+        line = lines[j]
+        stripped = line.strip
+        return nil if stripped.empty?
+        return line unless stripped.start_with?("#")
+
+        j += 1
+      end
+      nil
+    end
+
     def handle_empty_line(line)
       @result_lines << line.rstrip
     end
@@ -109,6 +137,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.12"
 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.12
 platform: ruby
 authors:
 - Justyna
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- AGENTS.md
 - LICENSE
 - README.md
 - Rakefile