no_comments 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f4d0bbabf8d2083a22cb850026add69671c3af79b1d0cb75a0a891e5187aea4
-  data.tar.gz: a8a312eea4658d6da9ac64007d9da4ea94efc642fc0381406e4fbc82b0b84726
+  metadata.gz: '0778f4eb4bbe1723231e1668730a87d462f154221fb7097fa35d21d5b34e832c'
+  data.tar.gz: f65eec62db3eab6acec0f44f4b02a2bc5983bf559aae3cec96855c4996d66a5e
 SHA512:
-  metadata.gz: aa15e36876ee00b72f23b2043eb661a736df5de5876b14e5e587cb04c99e7af9858d8f030520efac7af0ff8939901571a12f67f72182f87e6e94ae9abc1eb779
-  data.tar.gz: a3aa64ab64f4c7ba06da376b7fe16e027d363b8a22626b5b23e7a5c6d99051939dd23039751ac14ed3f27258abdcf7c5869516c5fdcfc772c0f81c67e1d23478
+  metadata.gz: 4d8805b6f04b9a1ac48c8992b274f29c5f5ca0574ebebe2ed28fa9b2abf92e2bc87063100ade5365b73fd8d0b185142b521683e3b84a48c863897a7d656c7b27
+  data.tar.gz: 9c1af8324d295c9bc1fc1174d4789004e001758ac3e198d8c1735c27ef64e317367158b0097301331a4bb591810567f4c8e33687b45dc6a956c52e99fff2d706

data/.rubocop.yml

@@ -16,6 +16,10 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/no_comments/**/*'
 
+Metrics/ClassLength:
+  Max: 120
+
+
 Style/Documentation:
   Enabled: false
 

data/README.md

@@ -1,6 +1,6 @@
 # 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.
+`no_comments` is a simple Ruby gem that removes comments from `.rb` files. It can handle single-line, block and inline comments, leaving your code clean and readable.
 
 ---
 
@@ -35,7 +35,7 @@ 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.
+To clean up comments from a .rb file or directory, use the `NoComments::Remover.clean` method. This will remove all single-line, block and inline comments from the file or directory.
 
 ```ruby
 require 'no_comments'
@@ -115,7 +115,6 @@ 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/exe/no_comments

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "optparse"
-require "no_comments"
+require "no_comments/remover"
 
 options = {}
 OptionParser.new do |opts|

data/lib/no_comments/content_processor.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "no_comments/version"
+
+module NoComments
+  class ContentProcessor
+    def initialize
+      @comments = []
+      @result_lines = []
+      @in_multiline_comment = false
+      @in_heredoc = false
+      @heredoc_delimiter = nil
+      @line_number = 0
+    end
+
+    def process(content)
+      content.each_line do |line|
+        @line_number += 1
+        stripped_line = line.strip
+        process_line(line, stripped_line)
+      end
+
+      cleaned_content = @result_lines.join("\n")
+      cleaned_content += "\n" unless cleaned_content.empty?
+      [cleaned_content, @comments]
+    end
+
+    def process_line(line, stripped_line)
+      if @in_multiline_comment
+        handle_multiline_comment(stripped_line)
+      elsif @in_heredoc
+        handle_heredoc(line, stripped_line)
+      else
+        handle_regular_line(line, stripped_line)
+      end
+    end
+
+    def handle_multiline_comment(stripped_line)
+      @comments << [@line_number, stripped_line]
+      @in_multiline_comment = false if stripped_line == "=end"
+    end
+
+    def handle_heredoc(line, stripped_line)
+      @result_lines << line.rstrip
+      @in_heredoc, @heredoc_delimiter = self.class.update_heredoc_state(
+        stripped_line, @heredoc_delimiter
+      )
+    end
+
+    def handle_regular_line(line, stripped_line)
+      if stripped_line == "=begin"
+        start_multiline_comment(stripped_line)
+      elsif (heredoc_start = self.class.detect_heredoc_start(line))
+        start_heredoc(line, heredoc_start)
+      else
+        process_code_line(line)
+      end
+    end
+
+    def start_multiline_comment(stripped_line)
+      @in_multiline_comment = true
+      @comments << [@line_number, stripped_line]
+    end
+
+    def start_heredoc(line, heredoc_start)
+      @in_heredoc = true
+      @heredoc_delimiter = heredoc_start
+      @result_lines << line.rstrip
+    end
+
+    def process_code_line(line)
+      code_part, comment_part = self.class.split_line(line)
+      @comments << [@line_number, comment_part.strip] if comment_part
+      return if code_part.strip.empty?
+
+      @result_lines << code_part.rstrip
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/BlockNesting
+    def self.split_line(line)
+      in_single_quote = false
+      in_double_quote = false
+      in_regex = false
+      escape = false
+      index = 0
+
+      while index < line.length
+        char = line[index]
+
+        if escape
+          escape = false
+        else
+          case char
+          when "\\"
+            escape = true
+          when "'"
+            in_single_quote = !in_single_quote unless in_double_quote || in_regex
+          when '"'
+            in_double_quote = !in_double_quote unless in_single_quote || in_regex
+          when "/"
+            if in_regex
+              in_regex = false
+            elsif !in_single_quote && !in_double_quote &&
+                  preceding_char_is_operator?(line, index)
+              in_regex = true
+            end
+          when "#"
+            result = handle_comment_character(line, index, in_single_quote, in_double_quote, in_regex)
+            return result if result
+          end
+        end
+        index += 1
+      end
+      [line, nil]
+    end
+
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/BlockNesting
+
+    def self.handle_comment_character(line, index, in_single_quote, in_double_quote, in_regex)
+      unless in_single_quote || in_double_quote || in_regex
+        code_part = line[0...index]
+        comment_part = line[index..]
+        return [code_part, comment_part]
+      end
+      nil
+    end
+
+    def self.update_heredoc_state(stripped_line, heredoc_delimiter)
+      if stripped_line == heredoc_delimiter
+        [false, nil]
+      else
+        [true, heredoc_delimiter]
+      end
+    end
+
+    def self.detect_heredoc_start(line)
+      if (match = line.match(/<<[-~]?(["'`]?)(\w+)\1/))
+        match[2]
+      end
+    end
+
+    def self.preceding_char_is_operator?(line, index)
+      return true if index.zero?
+
+      prev_char = line[index - 1]
+      prev_char =~ %r{[\s(,=+\-*/%|&!<>?:]}
+    end
+  end
+end

data/lib/no_comments/remover.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "no_comments/version"
+require "no_comments/content_processor"
+
+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)
+      content = File.read(file_path)
+
+      cleaned_content, comments = process_content(content)
+
+      if audit
+        print_audit(file_path, comments)
+      else
+        File.write(file_path, cleaned_content)
+      end
+    end
+
+    def self.validate_file_extension(file_path)
+      raise "Only Ruby files are supported" unless file_path.end_with?(".rb")
+    end
+
+    def self.process_content(content)
+      processor = NoComments::ContentProcessor.new
+      processor.process(content)
+    end
+
+    def self.print_audit(file_path, comments)
+      return if comments.empty?
+
+      puts "File: #{file_path}"
+      comments.each do |line_number, comment_text|
+        puts "  Line #{line_number}: #{comment_text}"
+      end
+    end
+  end
+end

data/lib/no_comments/version.rb

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

data/lib/no_comments.rb

@@ -1,76 +1,7 @@
 # frozen_string_literal: true
 
-require "no_comments/version"
-require "ripper"
+require "no_comments/content_processor"
+require "no_comments/remover"
 
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: no_comments
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Justyna
@@ -25,6 +25,8 @@ files:
 - Rakefile
 - exe/no_comments
 - lib/no_comments.rb
+- lib/no_comments/content_processor.rb
+- lib/no_comments/remover.rb
 - lib/no_comments/version.rb
 - sig/no_comments.rbs
 homepage: