no_comments 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8b64729d21c62f938c510fe179a75bdd4e642336830f043e37852351fe2f7e7
-  data.tar.gz: 5e36dc7b0751f92f6dba54b42e4f1b89d8612a2ac15e236dbe362e09152b51e5
+  metadata.gz: 5680480af7ba824c7591147b05fb53fc1368695d834518889d42707c9f98306b
+  data.tar.gz: 562fc50c7bcce1ee7dde8296c984dbde4935de25930c4adffbd3c99f22f5cac5
 SHA512:
-  metadata.gz: 86877162d04e05f36347fb23b9259064e44acae9b0e9bda4411af13884195b023e909ffbf57dca41b04dfe371ef748d663db22c4fcefd5336d0a3e691addaf58
-  data.tar.gz: 0bd8e85a51c4d495aacfa42d8c1c7c755064116761fd56e2a46cc53b14a298bfae65399027daf31dc93a537a5ff64e52bf88f9414be67a10efb91ccac6510a7c
+  metadata.gz: 7f26162ead8d4299371496f7c949aa0992bca529bc2e5ee63f52a2c159e2e493000255cf2676fd0ae79666c73521061fca2ee76fe5ace79bb33a6d1897f8cb39
+  data.tar.gz: c2205fc1deb3fac280a5b3b3b33bfc1106d68508a9c4b56987d1f7419778d6cba429b7c1f6ed8658d2dce3f3bc92bc37c3a33bc7fd7053960efb5a61106e73c8

data/README.md

@@ -16,8 +16,8 @@ It preserves:
 - Documentation comments (e.g., # @param id)
 
 ## Table of Contents
-1. [When to Use This Gem](#When-to-Use-This-Gem)
-2. [When Not to Use This Gem](#When-Not-to-Use-This-Gem)
+1. [When to Use This Gem](#when-to-use-this-gem)
+2. [When Not to Use This Gem](#when-not-to-use-this-gem)
 3. [Installation](#Installation)
 4. [Usage](#Usage)
    - [Audit Mode](#Audit-Mode)
@@ -29,21 +29,22 @@ It preserves:
 
 ## When to Use This Gem
 
-NoComments is particularly useful in the following scenarios:
+NoComments keeps Ruby code tidy by automatically removing unnecessary comments. It can be integrated into an MCP server to sanitize scripts before deployment, ensuring that the code published on the server is clean and production ready.
 
-- **Auto-Generated or Boilerplate Code:** Helps clean up scaffolding or boilerplate comments, commonly generated in frameworks like Rails.
-- **Codebases with Overused Comments:** Removes redundant comments that restate obvious code.
-- **Continuous Integration/Code Review Workflows:** Automates comment cleanup during CI/CD processes.
-- **Educational Projects:** Streamlines code by removing teaching-related comments after the learning phase.
-- **Maintaining Open Source Projects:** Ensures consistency by removing unnecessary comments in contributions.
+**Example use cases:**
+- **Auto-generated code** – clear scaffolding comments produced by frameworks such as Rails.
+- **Projects with excessive comments** – remove remarks that simply restate obvious code.
+- **CI/CD pipelines** – incorporate NoComments as a step that enforces code cleanliness.
+- **Educational projects** – clean files once learning phases are complete.
+- **Maintaining open source projects** – keep contributions consistent and readable.
 
 ## When Not to Use This Gem
 
-While the gem is powerful, it may not be suitable in these scenarios:
+While NoComments streamlines your code, it is not a replacement for documentation comments or notes that are required for compliance.
 
-- **Code with Valuable Documentation Comments:** Avoid using the gem if your code relies on comments for explaining complex logic or business rules.
-- **Codebases Requiring Compliance:** In regulated industries, where specific comments are required for audits or documentation purposes.
-- **Highly Dynamic Environments:** In fast-changing projects, comments might provide crucial context for recent changes or decisions.
+- **Code with valuable documentation** – when comments explain complex algorithms or important business decisions.
+- **Regulated industries** – if comments are mandatory for audit purposes.
+- **Rapidly changing projects** – when comments capture ongoing discussions or decisions.
 
 ## Installation
 
@@ -77,6 +78,12 @@ NoComments::Remover.clean('path/to/your_file.rb')
 
 # Clean all `.rb` files in a directory
 NoComments::Remover.clean('path/to/your_directory')
+
+# Clean all `.rb` files except selected ones or directories
+NoComments::Remover.clean('path/to/your_directory', exclude: ['skip.rb', 'subdir'])
+# Multiple files or directories can be provided, and blank entries are ignored.
+# Absolute or relative paths work, and directories may have a trailing slash.
+NoComments::Remover.clean('/abs/path/project', exclude: ['/abs/path/project/subdir/'])
 ```
 ### Audit Mode
 Audit mode allows you to preview the comments that would be removed without modifying the files. Use the `audit: true` flag with the `clean` method:
@@ -119,6 +126,13 @@ no_comments -p path/to/file.rb --keep-doc-comments
 no_comments -p path/to/directory --keep-doc-comments
 ```
 
+#### Exclude Paths
+```bash
+no_comments -p path/to/directory --exclude file1.rb,subdir
+# absolute paths and trailing slashes are supported. Blank entries are ignored.
+no_comments -p /project --exclude /project/subdir/
+```
+
 ## Testing
 
 This gem uses RSpec for testing. To run tests:
@@ -127,7 +141,7 @@ This gem uses RSpec for testing. To run tests:
 ```bash
 bundle install
 ```
-2. Run the test suite::
+2. Run the test suite:
 ```bash
 bundle exec rspec
 ```
@@ -159,7 +173,7 @@ 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
-- **Selective Cleaning:**
+- [x] **Selective Cleaning:**
   - Allow users to clean all files in a directory except for specified ones.
 
 ---

data/exe/no_comments

@@ -19,11 +19,20 @@ OptionParser.new do |opts|
   opts.on("-d", "--keep-doc-comments", "Preserve documentation comments like @param") do
     options[:keep_doc_comments] = true
   end
+
+  opts.on("-e", "--exclude x,y,z", Array, "Files to exclude when cleaning a directory") do |list|
+    options[:exclude] = list
+  end
 end.parse!
 
 if options[:path]
   begin
-    NoComments::Remover.clean(options[:path], audit: options[:audit], keep_doc_comments: options[:keep_doc_comments])
+    NoComments::Remover.clean(
+      options[:path],
+      audit: options[:audit],
+      keep_doc_comments: options[:keep_doc_comments],
+      exclude: options[:exclude] || []
+    )
     if options[:audit]
       puts "Audit completed successfully."
     else

data/lib/no_comments/remover.rb

@@ -4,9 +4,14 @@ require "no_comments/version"
 require "no_comments/content_processor"
 module NoComments
   class Remover
-    def self.clean(file_path, audit: false, keep_doc_comments: false)
+    def self.clean(file_path, audit: false, keep_doc_comments: false, exclude: [])
       if File.directory?(file_path)
+        filtered = exclude.reject { |p| p.nil? || p.strip.empty? }
+        excluded = filtered.map { |f| File.expand_path(f, file_path) }
         Dir.glob("#{file_path}/**/*.rb").each do |file|
+          absolute = File.expand_path(file)
+          next if excluded_file?(absolute, excluded)
+
           process_file(file, audit: audit, keep_doc_comments: keep_doc_comments)
         end
       else
@@ -14,6 +19,13 @@ module NoComments
       end
     end
 
+    def self.excluded_file?(absolute, paths)
+      paths.any? do |path|
+        absolute == path ||
+          (File.directory?(path) && absolute.start_with?(File.join(path, "")))
+      end
+    end
+
     def self.process_file(file_path, audit: false, keep_doc_comments: false)
       validate_file_extension(file_path)
       content = File.read(file_path)

data/lib/no_comments/version.rb

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

metadata

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