cleanio 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed57e0bb111c6d0b05161f098fd7494c13c5b1d3722e08f7199d4a8bbe12d162
-  data.tar.gz: b6ca75aebe1758166ef4dc7ddd2cf5ae154bd05274a6a451893e6832817dde4d
+  metadata.gz: 036c8a1c4dde80a666690afad1a7627096d32c41be872b10aff0a00f8c89ac49
+  data.tar.gz: 023bc640786b9aa3f75267ac62452f6de89ec803bf9c155031c0cc4cdaaf3756
 SHA512:
-  metadata.gz: 4bfc8e9e15d1c7d8ac647de328976f0acb4ee8790a50436a2ef4fcdac1f4ef40d9ef405bb5ad31c6c22405b24c7c62ab73bb1ad1d4ab4915718eab6a1f9edbf0
-  data.tar.gz: 972814f60a30461276fca1ac7c6ee171993082ed1c908ca68b6d0c5f569ff1f9f4f93398b02e807ca3b61889e6fb56c9321ff9696856d9d18c1c6fe264f65077
+  metadata.gz: f2dc6bf75656154a3a3454a611df2db1f5ad5e6064bcb4415b07861e8df3548ece27074e0db066eba7bb98d5c6467708df8c2215f069b64896adbf280d038808
+  data.tar.gz: 3b5869730b6d131087e52d3c39ed2762c32649f5eab7251a85ad4a5cc5edde7b9fc6564035a50f59b056449404c2e709561426fd821dc3c993f5a90787e565a4

data/.rubocop.yml

@@ -29,3 +29,6 @@ RSpec/MultipleExpectations:
 RSpec/DescribeClass:
   Exclude:
     - 'spec/cleanio/cleanio_cli_spec.rb'
+
+RSpec/NestedGroups:
+  Enabled: false

data/README.md

@@ -35,16 +35,18 @@ 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 file.
+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
 
@@ -68,14 +70,16 @@ You can use Cleanio directly from the command line to clean or audit `.rb` files
 To remove comments from a file, use:
 
 ```bash
-cleanio -f path/to/file.rb
+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/file.rb --audit
+cleanio -p path/to/file.rb --audit
+cleanio -p path/to/directory --audit
 ```
 
 ## Testing
@@ -114,5 +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

data/exe/cleanio

@@ -8,22 +8,26 @@ options = {}
 OptionParser.new do |opts|
   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 file paths and comment lines without modifying files") do
+
+  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], audit: options[:audit])
-    puts "Audit completed successfully." if options[:audit]
-    puts "File cleaned successfully." unless options[:audit]
+    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 "Please provide a file path using the -f flag."
+  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.2"
+  VERSION = "0.1.3"
 end

data/lib/cleanio.rb

@@ -6,8 +6,19 @@ require "ripper"
 module Cleanio
   class Remover
     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)
+
       if audit
         audit_comments(file_path, file_content)
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cleanio
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  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: