no_comments 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f4d0bbabf8d2083a22cb850026add69671c3af79b1d0cb75a0a891e5187aea4
+  data.tar.gz: a8a312eea4658d6da9ac64007d9da4ea94efc642fc0381406e4fbc82b0b84726
+SHA512:
+  metadata.gz: aa15e36876ee00b72f23b2043eb661a736df5de5876b14e5e587cb04c99e7af9858d8f030520efac7af0ff8939901571a12f67f72182f87e6e94ae9abc1eb779
+  data.tar.gz: a3aa64ab64f4c7ba06da376b7fe16e027d363b8a22626b5b23e7a5c6d99051939dd23039751ac14ed3f27258abdcf7c5869516c5fdcfc772c0f81c67e1d23478

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/no_comments/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/no_comments/**/*'
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/no_comments/no_comments_cli_spec.rb'
+
+RSpec/NestedGroups:
+  Enabled: false

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Justyna Wojtczak
+
+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.

data/README.md

@@ -0,0 +1,121 @@
+# no_comments
+
+`no_comments` 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.
+
+---
+
+## Table of Contents
+
+1. [Installation](#installation)
+2. [Usage](#usage)
+3. [Testing](#testing)
+4. [Contribution](#contribution)
+5. [License](#license)
+6. [TODO](#todo)
+
+---
+
+## Installation
+
+To install `no_comments`, add it to your Gemfile:
+
+```ruby
+gem 'no_comments'
+```
+Then execute:
+
+```bash
+bundle install
+```
+Or install it yourself using the following command:
+
+```bash
+gem install no_comments
+```
+
+
+## Usage
+To clean up comments from a .rb file or directory, use the `NoComments::Remover.clean` method. This will remove all single-line comments and inline comments from the file or directory.
+
+```ruby
+require 'no_comments'
+
+NoComments::Remover.clean('path/to/your_file.rb')
+NoComments::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
+NoComments::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 `no_comments` directly from the command line to clean or audit `.rb` files.
+
+#### Clean Comments
+
+To remove comments from a file, use:
+
+```bash
+no_comments -p path/to/file.rb
+no_comments -p path/to/directory
+```
+#### Audit mode
+
+To run `no_comments` in audit mode without modifying files, use the `--audit` flag:
+
+```bash
+no_comments -p path/to/file.rb --audit
+no_comments -p path/to/directory --audit
+```
+
+## Testing
+`no_comments` uses RSpec for testing. To run the tests, first make sure all dependencies are installed:
+
+```bash
+bundle install
+```
+Then, run the tests with:
+
+```bash
+bundle exec rspec
+```
+All tests are located in the spec directory and cover the main functionality of the gem, ensuring it properly removes comments from Ruby files.
+
+## Contribution
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/justi/no_comments.
+
+To contribute:
+
+Fork the repository.
+Create a new branch (git checkout -b feature-branch).
+Make your changes.
+Commit your changes (git commit -m 'Add new feature').
+Push to the branch (git push origin feature-branch).
+Open a pull request.
+
+Please ensure that your code follows the existing style and that all tests pass.
+
+## License
+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 keep documentation comments (e.g. `# @param`) https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/Documentation
+- Option to clean all files in a directory except for a specified file

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/no_comments

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require "no_comments"
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: no_comments [options]"
+
+  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[:path]
+  begin
+    NoComments::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 or directory with -p."
+end

data/lib/no_comments/version.rb

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

data/lib/no_comments.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "no_comments/version"
+require "ripper"
+
+module NoComments
+  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
+        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)
+      remove_empty_lines(content)
+    end
+
+    def self.extract_comments(content)
+      Ripper.lex(content).select { |_pos, type, _tok, _| type == :on_comment }
+    end
+
+    def self.process_comments(content, comments)
+      comments.sort_by { |(pos, _, _, _)| [pos[0], pos[1]] }.reverse.each do |(pos, _, _, _)|
+        line, col = pos
+        lines = content.lines
+        lines[line - 1] = process_comment_line(lines[line - 1], col)
+        content = lines.join
+      end
+      content
+    end
+
+    def self.process_comment_line(line, col)
+      if line[col..].strip.start_with?("#")
+        "#{line[0...col].rstrip}\n"
+      else
+        "\n"
+      end
+    end
+
+    def self.remove_empty_lines(content)
+      content.gsub(/^\s*$\n/, "")
+    end
+  end
+end

data/sig/no_comments.rbs

@@ -0,0 +1,4 @@
+module NoComments
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: no_comments
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Justyna
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-16 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- justine84@gmail.com
+executables:
+- no_comments
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- exe/no_comments
+- lib/no_comments.rb
+- lib/no_comments/version.rb
+- sig/no_comments.rbs
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Remove comments from Ruby files
+test_files: []