rebundler 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a699f86063d76f1777e967eb5aa993fe2d65c355812dbd50ec4a599653bac37
-  data.tar.gz: b1724cdc2493ef5745b23acac611c4a820fce04afaff0b0e7983085a291639e1
+  metadata.gz: f39f0bba7935159299bb736312beb6b0452d8997bb1f6c5bf574747b08d05af3
+  data.tar.gz: f8920192f0a6bf48ba31f21f67f8cba06d1a682e00196a89750aed089bb392bb
 SHA512:
-  metadata.gz: a8be976be4c69cba77b1d4a031adfefb52917637693f6ebd2f64307df602d397904f1c1f38321ac0b7c1c8225374550da3e79b8242b37ac9311b09334da3daf6
-  data.tar.gz: f7eb7094cabef8b94a49a82e5ad7d295da07e8d66a91d6b77bd669c6f04176003acf3594acb058b80258a5632aece21492c88283cb186668b10aa1131c49a316
+  metadata.gz: 8a1144be379a959ed76e26635daf82a9e535dc8e8ac416f2509206c95f9b6673b349f62ed80260f7703e83781cf657d20ef7e0e5ba3b6ef732e7404c6e4cb543
+  data.tar.gz: fa7d2a0423b94382e778ac048defebfe6301d994d860f1040f1cac509e9f617903234ea2eea1f2c5400f8d020183d14bd370a8617287fe0c1203a474f039d024

data/.rubocop.yml

@@ -23,3 +23,6 @@ Style/StringConcatenation:
 
 Layout/LineLength:
   Enabled: false
+
+Lint/ItWithoutArgumentsInBlock:
+  Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## [Unreleased]
+## [0.5.0] - 2026-03-13
+
+- Major internal refactor and clean up.
+
+  You can now instantiate the parser via `Rebundler::Parser.from_file(path)` or directly
+  from a string via `Rebundler::Parser.from_string(content)`.
+
+## [0.4.0] - 2025-12-21
+
+- **Breaking** Rebundler now leaves existing trailing comments intact.
+
+  You can still overwrite them (the previous behavior) by using the `--force` flag.
 
 ## [0.3.1] - 2025-12-19
 

data/README.md

@@ -18,7 +18,6 @@ This is a real life example from my own project. That looks a lot better, doesn'
 
 ## Known limitations
 
-- **Existing comments will be lost.** At this moment Rebundler does not persist existing comments.
 - **Probably does not work with all possible Gemfile configurations.** It is designed to work with the most common setups right now. If you encounter an issue, please open an issue on GitHub. I strive to support each sensible configuration.
 
 ## Installation
@@ -57,6 +56,8 @@ This does **not** load the plugin and means you have to run rebundler yourself b
 
 ```sh
 $ bundle exec rebundle
+Reordering and annotating Gemfile...
+✓ Gemfile has been reordered and annotated
 ```
 
 ### 3. CI mode
@@ -68,6 +69,47 @@ If there are differences, rebundler will exit with a non-zero status code.
 
 This does not write to the Gemfile.
 
+### Options
+
+### `--force`
+
+By default, Rebundler preserves existing trailing comments on `gem` defining lines. If you want to overwrite them anyway, use the `--force` flag:
+
+```sh
+$ bundle exec rebundle --force
+```
+
+## Interface
+
+You can also use Rebundler directly in Ruby rather than via the CLI.
+
+### `Parser.from_file(path)`
+
+Parses a Gemfile at the given path and returns a `Parser` instance.
+
+```ruby
+parser = Rebundler::Parser.from_file("/path/to/Gemfile")
+```
+
+### `Parser.from_string(content)`
+
+Parses a Gemfile from a string and returns a `Parser` instance.
+
+```ruby
+content = File.read("/path/to/Gemfile")
+parser = Rebundler::Parser.from_string(content)
+```
+
+### `parser.format(overwrite_comments: false)`
+
+Returns the formatted Gemfile content as a string. Does not write to disk.
+
+Pass `overwrite_comments: true` to replace existing trailing comments on `gem` lines (equivalent to the `--force` CLI flag):
+
+```ruby
+new_content = parser.format(overwrite_comments: true)
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/rebundle

@@ -5,33 +5,35 @@ require_relative "../lib/rebundler"
 
 # Parse command line arguments
 ci_mode = ARGV.include?("--ci")
+overwrite_comments = ARGV.include?("--force")
 file = ARGV.reject { |arg| arg.start_with?("--") }[0] || (Dir.pwd + "/Gemfile")
 
-puts "Reordering and annotating Gemfile..."
-
 begin
   # Load all gems in the Gemfile so we can use them to grab the summary instead of
   # having to hit rubygems.org
   Bundler.setup
-  parser = Rebundler::Parser.new(file)
-  new_content = parser.parse_and_write!
+  parser = Rebundler::Parser.from_file(file)
+  new_content = parser.format(overwrite_comments:)
 
   if ci_mode
     # In CI mode, compare the new content with the existing file
+    puts "Checking if Gemfile is properly formatted..."
     current_content = File.read(file)
 
     if new_content == current_content
-      puts "✓ Gemfile is already properly formatted"
+      puts "\e[32m✓ Gemfile is properly formatted\e[0m"
       exit 0
     else
-      puts "✗ Gemfile is not properly formatted"
-      puts "Run 'rebundle' to fix formatting issues"
+      puts "\e[31m✗ Gemfile is not properly formatted\e[0m"
+      puts "Run `bundle exec rebundle` to fix formatting issues"
       exit 1
     end
   else
     # In normal mode, write the new content to the file
+    puts "Reordering and annotating Gemfile..."
     File.write(file, new_content)
-    puts "✓ Gemfile has been reordered and annotated"
+    puts "\e[32m✓ Gemfile has been reordered and annotated\e[0m"
+
   end
 rescue StandardError => e
   puts "Error parsing Gemfile: #{e.message}"

data/lib/bundler/rebundle.rb

@@ -25,8 +25,8 @@ module Bundler
         # having to hit rubygems.org
         Bundler.setup
 
-        parser = ::Rebundler::Parser.new(file)
-        content = parser.parse_and_write!
+        parser = ::Rebundler::Parser.from_file(file)
+        content = parser.format
 
         # Use atomic write to prevent corruption if write fails
         Tempfile.create("Gemfile", Bundler.root.to_s) do |tmp|

data/lib/rebundler/{writer.rb → formatter.rb}

@@ -3,31 +3,36 @@
 require "forwardable"
 
 module Rebundler
-  class Writer
+  class Formatter
     extend Forwardable
 
-    def_delegators :@parser, :preamble_nodes, :gem_sets, :frozen_string_literal
+    def_delegators :@parser, :directives, :gem_sets, :frozen_string_literal, :comments
 
     def initialize(parser)
       @parser = parser
     end
 
-    def write!
+    def format(overwrite_comments: false)
       buffer = []
 
       buffer << "# frozen_string_literal: true" if frozen_string_literal
 
-      preamble_nodes.each do |node|
+      directives.each do |node|
         buffer << Serializer.node_to_s(node)
       end
 
       gem_sets.sort.each do |set|
         gem_content = [set.plugins, set.gems].map do |nodes|
-          sorted = nodes.sort_by { |node| node[:name].tr("-_", "").downcase }
-
-          sorted.map do |gem|
-            line = +Serializer.node_to_s(gem[:node])
-            line << " # #{gem[:summary]}" if gem[:summary]
+          nodes.sort.map do |gem|
+            existing_comment = Serializer.extract_comment(gem.node, comments)
+            comment = if existing_comment && !overwrite_comments
+                        existing_comment
+                      else
+                        gem.summary
+                      end
+
+            line = +Serializer.node_to_s(gem.node)
+            line << " # #{comment}" if comment
             line
           end.join("\n")
         end.reject(&:empty?).join("\n\n")

data/lib/rebundler/gem_declaration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rebundler
+  GemDeclaration = Data.define(:name, :summary, :node) do
+    def <=>(other)
+      raise ArgumentError, "comparison of GemDeclaration with #{other.class} failed" unless other.is_a?(GemDeclaration)
+
+      normalized_name <=> other.normalized_name
+    end
+
+    def normalized_name
+      name.tr("-_", "").downcase
+    end
+  end
+end

data/lib/rebundler/gem_set.rb

@@ -16,14 +16,14 @@ module Rebundler
     end
 
     def <=>(other)
-      return nil unless other.is_a?(GemSet)
+      raise ArgumentError, "comparison of GemSet with #{other.class} failed" unless other.is_a?(GemSet)
 
       # Default first, then sort by name
-      [default ? 0 : 1, name] <=> [other.default ? 0 : 1, other.name]
+      [default ? 0 : 1, name.to_s] <=> [other.default ? 0 : 1, other.name.to_s]
     end
 
     def ==(other)
-      other.is_a?(GemSet) && other.name == name
+      other.is_a?(GemSet) && other.name == name && other.default == default
     end
   end
 end

data/lib/rebundler/parser.rb

@@ -4,41 +4,44 @@ require "prism"
 
 module Rebundler
   class Parser
-    attr_reader :file, :preamble_nodes, :gem_sets, :frozen_string_literal
+    attr_reader :content, :frozen_string_literal, :directives, :gem_sets, :comments
 
-    def initialize(file)
-      @file = file
-      @frozen_string_literal = false
-      @preamble_nodes = []
-      @gem_sets = [GemSet.new(default: true)] # all gems outside a specific block (group, source, etc) will end up here
-    end
+    def self.from_file(path)
+      raise Rebundler::Error, "File not found: #{path}" unless File.exist?(path)
 
-    def build_set(name:, node: nil)
-      GemSet.new(name:, node:).tap do |set|
-        @gem_sets << set
-      end
+      new(File.read(path))
     end
 
-    def parse!
-      return if @parsed
-
-      parsed = Prism.parse(File.read(file))
+    def self.from_string(content)
+      new(content)
+    end
 
-      @frozen_string_literal = parsed.magic_comments.map(&:key).include?("frozen_string_literal")
+    def format(overwrite_comments: false)
+      Formatter.new(self).format(overwrite_comments:)
+    end
 
-      visitor = Visitor.new(self)
-      parsed.value.accept(visitor)
+    private_class_method :new
 
-      @parsed = true
-    end
+    def initialize(content)
+      @content = content
+      @frozen_string_literal = false
+      @directives = []
+      @gem_sets = [GemSet.new(default: true)]
+      @comments = []
 
-    def parse_and_write!
       parse!
-      Writer.new(self).write!
     end
 
-    def find_or_build_set(name:, node: nil)
-      gem_sets.find { |set| set.name == name } || build_set(name:, node:)
+    private
+
+    def parse!
+      parsed = Prism.parse(@content)
+
+      @frozen_string_literal = parsed.magic_comments.map(&:key).include?("frozen_string_literal")
+      @comments = parsed.comments
+
+      visitor = Visitor.new(self)
+      parsed.value.accept(visitor)
     end
   end
 end

data/lib/rebundler/serializer.rb

@@ -2,6 +2,22 @@
 
 module Rebundler
   class Serializer
+    def self.extract_comment(node, comments)
+      # Find comments that are on the same line as the node
+      node_line = node.location.end_line
+
+      trailing_comment = comments.find do |comment|
+        comment.location.start_line == node_line &&
+          comment.location.start_offset > node.location.end_offset
+      end
+
+      return nil unless trailing_comment
+
+      # Get the comment text (without the # prefix)
+      comment_text = trailing_comment.location.slice.sub(/^#\s*/, "").strip
+      comment_text.empty? ? nil : comment_text
+    end
+
     def self.node_to_s(node)
       lines = node.location.slice.lines
 
@@ -24,8 +40,10 @@ module Rebundler
     end
 
     def self.find_spacing_character(node)
-      # Assume it's formatted with tabs if there is ANY tab in the whole block of code.
-      node.location.slice.include?("\t") ? "\t" : " "
+      # Assume it's formatted with tabs if ANY line starts with a tab.
+      any_line_starts_with_tab = node.location.slice.split("\n").any? { it.start_with?("\t") }
+
+      any_line_starts_with_tab ? "\t" : " "
     end
   end
 end

data/lib/rebundler/summarizer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "timeout"
+
+module Rebundler
+  class Summarizer
+    class << self
+      def summarize(name)
+        find_loaded_gem_summary(name) || find_external_gem_summary(name)
+      end
+
+      private
+
+      def find_loaded_gem_summary(name)
+        gem = Gem::Specification.find_by_name(name)
+
+        gem.summary
+      rescue Gem::MissingSpecError
+        nil
+      end
+
+      def find_external_gem_summary(name)
+        spec = Gem::SpecFetcher.fetcher.spec_for_dependency Gem::Dependency.new(name)
+
+        return if spec.nil? || spec.first.empty?
+
+        spec.first.first.first.summary
+      rescue SocketError, Errno::ECONNREFUSED, Errno::ETIMEDOUT, Timeout::Error => e
+        raise Rebundler::Error, "Network error while fetching gem info for '#{name}': #{e.message}"
+      end
+    end
+  end
+end

data/lib/rebundler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rebundler
-  VERSION = "0.3.1"
+  VERSION = "0.5.0"
 end

data/lib/rebundler/visitor.rb

@@ -11,26 +11,43 @@ module Rebundler
     def visit_call_node(node)
       case node.name
       when :plugin
-        parsed_gem = GemFetcher.parse_gem(node)
-        @current_set.plugins << parsed_gem if parsed_gem
+        @current_set.plugins << parse_gem_with_comment(node)
       when :gem
-        parsed_gem = GemFetcher.parse_gem(node)
-        @current_set.gems << parsed_gem if parsed_gem
+        @current_set.gems << parse_gem_with_comment(node)
       when :git_source
-        @parser.preamble_nodes << node
-      when *BLOCK_NODES
+        @parser.directives << node
+      when *DIRECTIVE_AND_BLOCK_NODES
         if node.block
           # Use the full block declaration (e.g., "group :development do") as the unique name
           name = node.location.slice.lines.first.strip
 
           previous_set = @current_set
-          @current_set = @parser.find_or_build_set(name:, node:)
-          node.block.body&.accept(self)
+          @current_set = find_or_build_set(name:, node:)
+          node.block.body.accept(self)
           @current_set = previous_set
         else
-          @parser.preamble_nodes << node
+          @parser.directives << node
         end
       end
     end
+
+    private
+
+    def find_or_build_set(name:, node: nil)
+      @parser.gem_sets.find { |set| set.name == name } || build_set(name:, node:)
+    end
+
+    def build_set(name:, node: nil)
+      GemSet.new(name:, node:).tap do |set|
+        @parser.gem_sets << set
+      end
+    end
+
+    def parse_gem_with_comment(node)
+      name = node.arguments.child_nodes[0].content
+      summary = Summarizer.summarize(name)
+
+      GemDeclaration.new(name:, summary:, node:)
+    end
   end
 end

data/lib/rebundler.rb

@@ -9,5 +9,5 @@ module Rebundler
   class Error < StandardError; end
 
   SORTABLE_NODES = %i[plugin gem].freeze
-  BLOCK_NODES = %i[gemspec git group path platforms ruby source].freeze
+  DIRECTIVE_AND_BLOCK_NODES = %i[gemspec git group path platforms ruby source].freeze
 end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "4.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rebundler
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Dennis Paagman
@@ -25,13 +25,15 @@ files:
 - lib/bundler/rebundle.rb
 - lib/rebundler.rb
 - lib/rebundler/Rakefile
-- lib/rebundler/gem_fetcher.rb
+- lib/rebundler/formatter.rb
+- lib/rebundler/gem_declaration.rb
 - lib/rebundler/gem_set.rb
 - lib/rebundler/parser.rb
 - lib/rebundler/serializer.rb
+- lib/rebundler/summarizer.rb
 - lib/rebundler/version.rb
 - lib/rebundler/visitor.rb
-- lib/rebundler/writer.rb
+- mise.toml
 - plugins.rb
 homepage: https://github.com/dennispaagman/rebundler
 licenses:
@@ -55,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Rebundler makes your Gemfile look good.
 test_files: []

data/lib/rebundler/gem_fetcher.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Rebundler
-  class GemFetcher
-    class << self
-      def parse_gem(node)
-        return unless node.type == :call_node && SORTABLE_NODES.include?(node.name)
-
-        gem_name = node.arguments.child_nodes[0].content
-
-        find_gem(gem_name).merge(node:)
-      end
-
-      private
-
-      def find_gem(name)
-        summary = find_loaded_gem_summary(name) || find_external_gem_summary(name)
-
-        { name:, summary: }
-      end
-
-      def find_loaded_gem_summary(name)
-        gem = Gem::Specification.find_by_name(name)
-
-        gem.summary
-      rescue Gem::MissingSpecError
-        nil
-      end
-
-      def find_external_gem_summary(name)
-        spec = Gem::SpecFetcher.fetcher.spec_for_dependency Gem::Dependency.new(name)
-
-        return unless spec
-        # SpecFetcher returns [[], []] when gem exists but has no versions available
-        return if spec == [[], []]
-
-        spec.first.first.first.summary
-      end
-    end
-  end
-end