cleanio 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f0e7b2724b16024bbe777ea410ef369495f544ebcc3ca40f3cdd98219b18af
-  data.tar.gz: dfe2856b027bff85005a3957b44283544ba7ca171d3f010a7481a4f4c2f28814
+  metadata.gz: ed57e0bb111c6d0b05161f098fd7494c13c5b1d3722e08f7199d4a8bbe12d162
+  data.tar.gz: b6ca75aebe1758166ef4dc7ddd2cf5ae154bd05274a6a451893e6832817dde4d
 SHA512:
-  metadata.gz: aaf2ea9478bc1a29d8bbd7198fd31315f22f79f59c51e8db3f88473abd0a5808f12ab5e50be920ccf3eff714bc9c9ea71aa696f979832bbebbdc5e230f4f845b
-  data.tar.gz: 71f9d89066caa22d6c24ba2f1a33937215f2e7594b73969153586a3c57439a8646b7020e40acacd9e5036cba3eaef52b00a160f7e8153bc1ff781bb15ce3f06d
+  metadata.gz: 4bfc8e9e15d1c7d8ac647de328976f0acb4ee8790a50436a2ef4fcdac1f4ef40d9ef405bb5ad31c6c22405b24c7c62ab73bb1ad1d4ab4915718eab6a1f9edbf0
+  data.tar.gz: 972814f60a30461276fca1ac7c6ee171993082ed1c908ca68b6d0c5f569ff1f9f4f93398b02e807ca3b61889e6fb56c9321ff9696856d9d18c1c6fe264f65077

data/.rubocop.yml

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

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'
@@ -42,12 +42,41 @@ require 'cleanio'
 
 Cleanio::Remover.clean('path/to/your_file.rb')
 ```
-Alternatively, you can use the command line tool:
+### 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.
+
+#### Example
+
+```ruby
+Cleanio::Remover.clean('example.rb', audit: true)
+```
+#### Output
+
+```bash
+File: example.rb
+  Line 1: # This is a comment
+  Line 3: # Another comment
+```
+
+### 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 -f path/to/file.rb
+```
+#### Audit mode
+
+To run Cleanio in audit mode without modifying files, use the `--audit` flag:
 
 ```bash
-cleanio -f path/to/your_file.rb
+cleanio -f path/to/file.rb --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:
@@ -83,7 +112,7 @@ The gem is available as open source under the terms of the MIT License.
 
 ## TODO
 - 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,24 @@ 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
   end
+  opts.on("--audit", "Run in audit mode to display file paths and comment lines without modifying files") do
+    options[:audit] = true
+  end
 end.parse!
 
 if options[:file]
   begin
-    Cleanio::Remover.clean(options[:file])
-    puts "The comments were removed from #{options[:file]}"
+    Cleanio::Remover.clean(options[:file], audit: options[:audit])
+    puts "Audit completed successfully." if options[:audit]
+    puts "File cleaned successfully." unless options[:audit]
   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 path using the -f flag."
 end

data/lib/cleanio/version.rb

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

data/lib/cleanio.rb

@@ -5,17 +5,31 @@ require "ripper"
 
 module Cleanio
   class Remover
-    def self.clean(file_path)
+    def self.clean(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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cleanio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Justyna
@@ -21,7 +21,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - exe/cleanio
@@ -41,7 +40,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Justyna
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.