rebundler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4fcf003a478f6954d9b00ceb4be97ad3a80676ca7590107f645614784662402
+  data.tar.gz: 923aef754252bfedb100489f1a3d574fb81c955857503e149d328443b4cf8682
+SHA512:
+  metadata.gz: 68cc4c80cb9858c9ff1918d241dcf61b3fb2eb85530ce3b592fff002992f3e28800d8752bffbfe6ea2ebcbbdb941b8ccf5c730752c3a56f4b5fb7396a4c017b3
+  data.tar.gz: bf8bcebd8b0b5bfb92833576968914cbbcb66205bcb7eb5d992cb8feeaa02c13eb2a33642b1322dc921bdb2d218023559b94c826015b9702aa7d6b2c1e35d80f

data/.rubocop.yml

@@ -0,0 +1,25 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-17
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dennis Paagman
+
+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,72 @@
+# Rebundler
+
+Rebundler automatically reorders and annotes your Gemfile.
+
+## Why would you want that?
+
+- **No more manual ordering of gems.** Let's admit that you usually just put them somewhere vaguely adjacent. Eventually your Gemfile will be a mess.
+- **No bike shedding about the structure of your Gemfile.** Rebundler will take care of it.
+- **More context on what gems do.** Especially with all the funky gem names in our community (which is fun!) it's not entirely clear from most names alone what it does. Rebundler will add a comment with the gem's description.
+
+## Example
+
+This is a real life example from my own project. That looks a lot better, doesn't it?
+
+| 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) |
+
+## 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
+
+There are two ways to install Rebundler.
+
+### 1. Automatic mode
+
+> [!NOTE]
+> This does not seem to work properly yet, I need to dig into why later.
+
+Simply add them gem to your Gemfile. the location does not matter as it will be resorted immediately.
+
+```ruby
+gem "rebundler"
+```
+
+This installs a Bundler plugin that automatically runs after installing gems. You should see a message in your terminal after running `bundle`:
+
+```sh
+$ bundle
+
+...
+
+Reordering and annotating Gemfile...
+Bundle complete! 10 Gemfile dependencies, 45 gems now installed.
+```
+
+### 2. Manual mode
+
+```ruby
+gem "rebundler", require: false
+```
+
+This does **not** load the plugin and means you have to run rebundler yourself by running the `rebundle` command:
+
+```sh
+$ bundle exec rebundle
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dennispaagman/rebundler.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/rebundle

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/rebundler"
+
+file = ARGV[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)
+  File.write(file, parser.write!)
+rescue StandardError => e
+  puts "Error parsing Gemfile: #{e.message}"
+end

data/lib/bundler/rebundle.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "bundler"
+
+module Bundler
+  class Rebundle < Bundler::Plugin::API
+    command "rebundle"
+
+    hook "after-install-all" do
+      parse_and_write_gemfile!
+    end
+
+    def exec(command, args)
+      send command, args
+    end
+
+    def self.parse_and_write_gemfile!
+      Bundler.ui.info "Reordering and annotating Gemfile..."
+
+      file = Bundler.root.to_s + "/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)
+        File.write(file, parser.write!)
+      rescue StandardError => e
+        Bundler.ui.error "Error parsing Gemfile: #{e.message}"
+        raise Bundler::PluginError, e
+      end
+    end
+  end
+end

data/lib/rebundler/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rebundler"
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/rebundler/parser.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require "prism"
+
+module Rebundler
+  class Parser
+    SORTABLE_NODES = %i[plugin gem].freeze
+    BLOCK_NODES = %i[gemspec git group path platforms ruby source].freeze
+
+    attr_reader :file, :before, :sets, :frozen_string_literal
+
+    def initialize(file)
+      @file = file
+      @frozen_string_literal = false
+      @before = []
+      @sets = [
+        { node: nil, plugin: [], gem: [] } # all gems outside a specific block (group, source, etc) will end up here
+      ]
+    end
+
+    def write!
+      parse!
+
+      buffer = []
+
+      buffer << "# frozen_string_literal: true" if frozen_string_literal
+
+      before.each do |node|
+        buffer << node_to_s(node)
+      end
+
+      sets.sort_by { node_to_s(_1[:node]) || "" }.each do |set|
+        set_node = set[:node]
+        set_buffer = []
+
+        set_buffer << [node_to_s(set_node), set_node.block.opening].compact.join(" ") if set_node
+
+        set_buffer << SORTABLE_NODES.map do |node_type|
+          nodes = set[node_type].sort_by { _1[:name] }
+
+          nodes.map do |gem|
+            line = +""
+            line << "  " if set_node
+            line << node_to_s(gem[:node])
+            line << " # #{gem[:summary]}" if gem[:summary]
+
+            line
+          end.join("\n")
+        end.reject(&:empty?).join("\n\n")
+
+        set_buffer << set_node.block.closing if set_node&.block
+
+        buffer << set_buffer.join("\n")
+      end
+
+      buffer.reject(&:empty?).join("\n\n") + "\n"
+    end
+
+    private
+
+    def parse!
+      parsed = Prism.parse(File.read(file))
+
+      @frozen_string_literal = parsed.magic_comments.map(&:key).include?("frozen_string_literal")
+
+      parsed.value.compact_child_nodes[0].compact_child_nodes.each do |node|
+        case node.type
+        when :call_node
+          case node.name
+          when *SORTABLE_NODES
+            @sets[0][node.name] << parse_gem(node)
+          when *BLOCK_NODES
+            if node.block
+              children = node.block.body.compact_child_nodes
+
+              set = { node:, plugin: [], gem: [] }
+
+              children.each do |child_node|
+                parsed_node = parse_gem(child_node)
+
+                set[child_node.name] << parsed_node if parsed_node
+              end
+
+              @sets << set
+            else
+              @before << node
+            end
+          end
+        end
+      end
+    end
+
+    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
+      return if spec == [[], []]
+
+      spec.first.first.first.summary
+    end
+
+    def node_to_s(node)
+      return if node.nil?
+
+      case node.type
+      when :call_node
+        [node.name, node_to_s(node.arguments)].compact.join(" ")
+      when :keyword_hash_node
+        node.elements.map do |element|
+          key = node_to_s(element.key)
+          value = node_to_s(element.value)
+
+          "#{key} #{value}"
+        end
+      when :symbol_node
+        "#{node.opening}#{node.value}#{node.closing}"
+      when :string_node
+        "#{node.opening}#{node.content}#{node.closing}"
+      when :array_node
+        separator = node.opening == "[" ? ", " : " "
+
+        node.opening + node.elements.map do |element|
+          node_to_s(element)
+        end.join(separator) + node.closing
+      when :true_node
+        "true"
+      when :false_node
+        "false"
+      when :arguments_node
+        return if node.child_nodes.empty?
+
+        node.child_nodes.map { node_to_s(_1) }.join(", ")
+      else
+        raise NotImplementedError, "Unknown node type: #{node.type}"
+      end
+    end
+
+    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
+  end
+end

data/lib/rebundler/version.rb

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

data/lib/rebundler.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "rebundler/version"
+require_relative "rebundler/parser"
+
+require_relative "bundler/rebundle"
+
+module Rebundler
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/plugins.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "lib/rebundler"

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: rebundler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Paagman
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- dennis@paagman.dev
+executables:
+- rebundle
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/rebundle
+- lib/bundler/rebundle.rb
+- lib/rebundler.rb
+- lib/rebundler/Rakefile
+- lib/rebundler/parser.rb
+- lib/rebundler/version.rb
+- plugins.rb
+homepage: https://github.com/dennispaagman/rebundler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dennispaagman/rebundler
+  source_code_uri: https://github.com/dennispaagman/rebundler
+  changelog_uri: https://github.com/dennispaagman/rebundler/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Rebundler makes your Gemfile look good.
+test_files: []