rebundler 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca1277ce8c48c32a188112502901feab5054e3f1169c9affafdfa67efc2ad5c6
-  data.tar.gz: 44175bed645dd17afd40630266b09d8f3455e4366078c55324da91396e59f2dc
+  metadata.gz: bd90571682828dd3a39d81faadcca42fb3003f2cdac7709b060b375dd43c44db
+  data.tar.gz: d3d922f26bc42111b9f333d714f8c89776f6a7d4c2541da245acbc29d803e4e8
 SHA512:
-  metadata.gz: 853ad9dfcd1305412a8ae3625f3d5a95a18a9944e1aa660b77b910accf5d0a9c1cbc1614d0410a459a82f966f3343c436a275a90eb060cfd416ddab3d7e47d8a
-  data.tar.gz: f3c323ad1ffb1b585008aa71e8b5aea817d7b54489b125f68e6cb958fa887ae2d437d37b5983af9df65cb823b863a7b5cccc657fb60ed1e86a42588f7f3f1966
+  metadata.gz: ff8197f9fc485081470bc387a897a702e05e34b2f5a15d910f6227df07f9cf917b184897294f71fc511710106b52d1c6fa1efbf134c6c4ab8e38e73484dd0f16
+  data.tar.gz: 99f3ec9e1ea7d21c01b1622137573273422d56ac7dd7e6aa29cf7c9a8c0d6239dc37ba7419a365a530b87897fb6e42ebae229f465082a0d58832799817426570

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [0.6.1] - 2026-06-18
+
+- Include pre-release versions when fetching external gem info, so gems published only
+  as pre-releases (e.g. `typesense-rails`) are found and get a generated trailing
+  comment. Stable gems still resolve to their latest stable version.
+
+## [0.6.0] - 2026-06-18
+
+- Add support for the `install_if` directive. `install_if` blocks are now parsed and
+  formatted like other directive blocks (`group`, `path`, etc.).
+- Fixed a crash when a block was empty.
+- Fall back to a gem's `description` when its `summary` is `nil` or blank, so the
+  generated trailing comment is still populated.
+- Declare `prism` and `zeitwerk` as runtime dependencies in the gemspec (they were
+  previously only in the Gemfile), fixing standalone installs of the gem.
+- Internal refactoring (inlined the summarizer into `GemDeclaration`) and dependency updates.
+
 ## [0.5.1] - 2026-03-13
 
 - Remove references to running as a bundler plugin. This does not work well, so decided to remove it.

data/README.md

@@ -10,19 +10,46 @@ Rebundler automatically reorders and annotates your Gemfile.
 
 ## Example
 
-This is a real life example from my own project. That looks a lot better, doesn't it?
+Take this small Gemfile:
 
-| Before                                                                                    | After                                                                                     |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| ![image](https://github.com/user-attachments/assets/42a76744-111b-4f73-bc62-8723637e6655) | ![image](https://github.com/user-attachments/assets/3ea6c70e-2239-4511-9040-c4db58203ec4) |
+```ruby
+source "https://rubygems.org"
+
+gem "rails"
+gem "puma"
+gem "avo"
+
+group :development do
+  gem "herb"
+end
+```
+
+After running Rebundler, the gems are sorted, and each one is annotated with its description:
+
+```ruby
+source "https://rubygems.org"
+
+gem "avo" # Admin panel framework and Content Management System for Ruby on Rails.
+gem "puma" # A Ruby/Rack web server built for parallelism.
+gem "rails" # Full-stack web application framework.
+
+group :development do
+  gem "herb" # The modern HTML+ERB Toolchain
+end
+```
+
+## Try it online
+
+You can play around with Rebundler in the [Rebundler Playground](https://rebundler.dev/). Just paste your Gemfile and hit **Rebundle**. It encodes the Gemfile in a hash in the URL, so you can easily share the result with others.
 
 ## Known limitations
 
 - **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 most sensible configurations.
+- **Non-trailing comments are discarded.** Rebundler keeps existing trailing comments on `gem` lines, but standalone comments and commented-out gems are removed.
 
 ## Installation
 
-First add `rebundler` to your Gemfile. `bundle add rebundler`. There are two ways to run Rebundler.
+Add it to your Gemfile with `bundle add rebundler`, or install it standalone with `gem install rebundler`. There are two ways to run Rebundler.
 
 ### 1. Writing mode
 
@@ -90,9 +117,19 @@ Pass `overwrite_comments: true` to replace existing trailing comments on `gem` l
 new_content = parser.format(overwrite_comments: true)
 ```
 
+## How it works
+
+Since Gemfiles are just regular Ruby files, Rebundler parses them with [Prism](https://github.com/ruby/prism). It walks the AST using Prism's visitor pattern to find `gem` declarations and groups, while keeping generic setup methods like `source`, `ruby`, and `git_source` at the top.
+
+Gems defined at the top level are grouped together. Gems inside blocks (like `group :development do ... end`) stay within their block, and duplicate groups are automatically merged. Within each group, gems are sorted alphabetically.
+
+Prism is only a parser, not a formatter, so Rebundler reconstructs the Gemfile with some string manipulation. Because Prism records the exact line and column of every node, Rebundler copies the original source for each gem verbatim — which keeps your existing style intact. It then loads each gem's description from your local bundle (fetching it from RubyGems if it's missing) and appends it as a trailing comment.
+
+By default, existing trailing comments are kept and other comments are discarded.
+
 ## 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.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec minitest` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 

data/lib/rebundler/gem_declaration.rb

@@ -1,15 +1,57 @@
 # frozen_string_literal: true
 
 module Rebundler
-  GemDeclaration = Data.define(:name, :summary, :node) do
+  class GemDeclaration
+    include Comparable
+
+    attr_reader :node
+
+    def initialize(node: nil)
+      @node = node
+    end
+
+    def name = @node.arguments.child_nodes[0].content
+    def normalized_name = name.tr("-_", "").downcase
+
+    def summary
+      gem = find_loaded_gem || find_external_gem
+
+      return if gem.nil?
+
+      if gem.summary.nil? || gem.summary == ""
+        gem.description
+      else
+        gem.summary
+      end
+    end
+
     def <=>(other)
-      raise ArgumentError, "comparison of GemDeclaration with #{other.class} failed" unless other.is_a?(GemDeclaration)
+      unless other.is_a?(GemDeclaration)
+        raise ArgumentError,
+              "comparison of GemDeclaration with #{other.class} failed"
+      end
 
       normalized_name <=> other.normalized_name
     end
 
-    def normalized_name
-      name.tr("-_", "").downcase
+    private
+
+    def find_loaded_gem
+      Gem::Specification.find_by_name(name)
+    rescue Gem::MissingSpecError
+      nil
+    end
+
+    def find_external_gem
+      dependency = Gem::Dependency.new(name).tap { |d| d.prerelease = true } # Also find prelease gems
+
+      spec = Gem::SpecFetcher.fetcher.spec_for_dependency(dependency)
+
+      return if spec.nil? || spec.first.empty?
+
+      spec.first.first.first
+    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

data/lib/rebundler/gem_set.rb

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

data/lib/rebundler/version.rb

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

data/lib/rebundler/visitor.rb

@@ -11,13 +11,18 @@ module Rebundler
     def visit_call_node(node)
       case node.name
       when :plugin
-        @current_set.plugins << parse_gem_with_comment(node)
+        @current_set.plugins << GemDeclaration.new(node:)
       when :gem
-        @current_set.gems << parse_gem_with_comment(node)
+        @current_set.gems << GemDeclaration.new(node:)
       when :git_source
+        # :git_source is a special case where it's a directive with a block that
+        # we don't want to add it as a set, which would happen if it's parsed in
+        # the condition for DIRECTIVE_AND_BLOCK_NODES below.
         @parser.directives << node
       when *DIRECTIVE_AND_BLOCK_NODES
         if node.block
+          return unless node.block.body
+
           # Use the full block declaration (e.g., "group :development do") as the unique name
           name = node.location.slice.lines.first.strip
 
@@ -42,12 +47,5 @@ module Rebundler
         @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

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

metadata

@@ -1,14 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: rebundler
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Dennis Paagman
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 email:
 - dennis@paagman.dev
 executables:
@@ -29,7 +57,6 @@ files:
 - 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
 - mise.toml
@@ -55,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Rebundler makes your Gemfile look good.
 test_files: []

data/lib/rebundler/summarizer.rb

@@ -1,33 +0,0 @@
-# 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