cleanio 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c42e0f9f14418be63dd899e7464b0436c7b5818ab58caa6b4e337a1991d4bc7
-  data.tar.gz: a363d3fee96907139c93f50962a73fd4e3ca0ea22fa81285baee09e3c96b448c
+  metadata.gz: 036c8a1c4dde80a666690afad1a7627096d32c41be872b10aff0a00f8c89ac49
+  data.tar.gz: 023bc640786b9aa3f75267ac62452f6de89ec803bf9c155031c0cc4cdaaf3756
 SHA512:
-  metadata.gz: b80973d46215050482dee5c9fa2aae917c1d6fafea0f731bc47a9c491f0754faaba0f773238f618ab56bfa0e4c43a9f384581c24d642c2b8f68faf935cb5f92d
-  data.tar.gz: f5fca8330175e5e246aec51483465ba58fb19aaaafb97b0e4676dce33e2027c51ea0449e4b564f6e8df19722bb1c81f008a1d0d89d90934d0218be9bd0444dfb
+  metadata.gz: f2dc6bf75656154a3a3454a611df2db1f5ad5e6064bcb4415b07861e8df3548ece27074e0db066eba7bb98d5c6467708df8c2215f069b64896adbf280d038808
+  data.tar.gz: 3b5869730b6d131087e52d3c39ed2762c32649f5eab7251a85ad4a5cc5edde7b9fc6564035a50f59b056449404c2e709561426fd821dc3c993f5a90787e565a4

data/.rubocop.yml

@@ -22,3 +22,13 @@ Style/Documentation:
 RSpec/ExampleLength:
   Exclude:
     - 'spec/cleanio/**/*'
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/cleanio/cleanio_cli_spec.rb'
+
+RSpec/NestedGroups:
+  Enabled: false

data/README.md

@@ -1,6 +1,6 @@
 # Cleanio
 
-`cleanio` is a simple Ruby gem that removes comments from `.rb` files. It can handle single-line comments and inline comments, leaving your code clean and readable.
+`Cleanio` is a simple Ruby gem that removes comments from `.rb` files. It can handle single-line comments and inline comments, leaving your code clean and readable.
 
 ---
 
@@ -17,7 +17,7 @@
 
 ## Installation
 
-To install `cleanio`, add it to your Gemfile:
+To install `Cleanio`, add it to your Gemfile:
 
 ```ruby
 gem 'cleanio'
@@ -35,19 +35,52 @@ gem install cleanio
 
 
 ## Usage
-To clean up comments from a .rb file, simply run:
+To clean up comments from a .rb file or directory, use the `Cleanio::Remover.clean` method. This will remove all single-line comments and inline comments from the file or directory.
 
 ```ruby
 require 'cleanio'
 
 Cleanio::Remover.clean('path/to/your_file.rb')
+Cleanio::Remover.clean('path/to/your_directory')
+
+```
+### Audit Mode
+
+To use the audit mode, pass the `audit: true` flag to the `clean` method. This will output the file paths and lines containing comments without modifying the files.
+
+#### Example
+
+```ruby
+Cleanio::Remover.clean('example.rb', audit: true)
+```
+#### Output
+
+```bash
+File: example.rb
+  Line 1: # This is a comment
+  Line 3: # Another comment
 ```
-Alternatively, you can use the command line tool:
+
+### Command-Line Interface (CLI)
+
+You can use Cleanio directly from the command line to clean or audit `.rb` files.
+
+#### Clean Comments
+
+To remove comments from a file, use:
+
+```bash
+cleanio -p path/to/file.rb
+cleanio -p path/to/directory
+```
+#### Audit mode
+
+To run Cleanio in audit mode without modifying files, use the `--audit` flag:
 
 ```bash
-cleanio -f path/to/your_file.rb
+cleanio -p path/to/file.rb --audit
+cleanio -p path/to/directory --audit
 ```
-This will remove all comments from the specified Ruby file.
 
 ## Testing
 Cleanio uses RSpec for testing. To run the tests, first make sure all dependencies are installed:
@@ -85,6 +118,4 @@ The gem is available as open source under the terms of the MIT License.
 - Add support multi-line comments (`=begin`...`=end`)
 - Add support to magic comments (e.g. `# frozen_string_literal: true`) https://docs.ruby-lang.org/en/3.2/syntax/comments_rdoc.html - thanks [Chris](https://github.com/khasinski)!
 - Option to stay documentation comments (e.g. `# @param`) https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/Documentation
-- Option to recursively clean all files in a directory
 - Option to clean all files in a directory except for a specified file
-- Option for audit mode (show what would be removed without actually removing it)

data/exe/cleanio

@@ -6,20 +6,28 @@ require "cleanio"
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: cleanio -f FILE"
+  opts.banner = "Usage: cleanio [options]"
 
-  opts.on("-f", "--file FIle", "Path to .rb file") do |file|
-    options[:file] = file
+  opts.on("-p", "--path PATH", "Path to a .rb file or directory") do |path|
+    options[:path] = path
+  end
+
+  opts.on("--audit", "Run in audit mode to display comments without modifying files") do
+    options[:audit] = true
   end
 end.parse!
 
-if options[:file]
+if options[:path]
   begin
-    Cleanio::Remover.clean(options[:file])
-    puts "The comments were removed from #{options[:file]}"
+    Cleanio::Remover.clean(options[:path], audit: options[:audit])
+    if options[:audit]
+      puts "Audit completed successfully."
+    else
+      puts "Cleaning completed successfully."
+    end
   rescue StandardError => e
     puts "Error: #{e.message}"
   end
 else
-  puts "You need to provide a file path with -f option"
+  puts "Please provide a file or directory with -p."
 end

data/lib/cleanio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cleanio
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/cleanio.rb

@@ -5,17 +5,42 @@ require "ripper"
 
 module Cleanio
   class Remover
-    def self.clean(file_path)
+    def self.clean(file_path, audit: false)
+      if File.directory?(file_path)
+        Dir.glob("#{file_path}/**/*.rb").each do |file|
+          process_file(file, audit: audit)
+        end
+      else
+        process_file(file_path, audit: audit)
+      end
+    end
+
+    def self.process_file(file_path, audit: false)
       validate_file_extension(file_path)
       file_content = File.read(file_path)
-      content_cleaned = remove_comments(file_content)
-      File.write(file_path, content_cleaned)
+
+      if audit
+        audit_comments(file_path, file_content)
+      else
+        content_cleaned = remove_comments(file_content)
+        File.write(file_path, content_cleaned)
+      end
     end
 
     def self.validate_file_extension(file_path)
       raise "Only Ruby files are supported" unless file_path.end_with?(".rb")
     end
 
+    def self.audit_comments(file_path, content)
+      comments = extract_comments(content)
+      puts "File: #{file_path}" unless comments.empty?
+
+      comments.each do |(pos, _, tok, _)|
+        line, = pos
+        puts "  Line #{line}: #{tok.strip}"
+      end
+    end
+
     def self.remove_comments(content)
       comments = extract_comments(content)
       content = process_comments(content, comments)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cleanio
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Justyna
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2024-11-16 00:00:00.000000000 Z
 dependencies: []
 description:
 email: