gem_sorter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b1e869f1a6001e39cb365ed94c07b7ae077002230b6b8310e3931b5021f96a6
+  data.tar.gz: 5d1dcf0f273f0c410fc7f4aa1221d0e61a7fa8ec8f86e20f01d46f8c601a06ab
+SHA512:
+  metadata.gz: 1bdc7618f04fd23841944fb2daf70255b3e9fbf83a780dfacf9a82f0b0ccc08dafbe5583bfeebffc8d6424374b7e9e9819ade35884b2cefd656d0aa0c8d5698a
+  data.tar.gz: 234b92e7d4829520db13b04707f9e6c5fdfebe6bde74a25eac7cd06ea8e435a173567287b32654d82c1c28ee9db4ee41e052f75376b81d603eee67787d17b300

data/README.md

@@ -0,0 +1,106 @@
+# GemSorter
+
+GemSorter is a simple gem to sort the contents of your Gemfile alphabetically while preserving comments and group structure. It helps maintain a clean and organized Gemfile.
+
+## Features
+* Sorts gems alphabetically.
+* Preserves comments and their association with gems.
+* Maintains group structure in the Gemfile.
+* Optionally creates a backup of the original Gemfile.
+
+## Installation
+Add the gem to your project's `Gemfile`:
+
+```ruby
+gem "gem_sorter"
+```
+
+## Usage
+Once installed, you can use the provided Rake task to sort your Gemfile:
+
+```bash
+rake gemfile:sort
+```
+
+### Options
+* `backup`: Pass `true` to create a backup of your Gemfile as `Gemfile.old` before sorting.
+
+Example:
+
+```bash
+rake gemfile:sort[true]
+```
+
+This will sort your Gemfile and create a backup.
+
+## Example
+### Input Gemfile
+```ruby
+source "https://rubygems.org"
+
+# Framework
+gem "rails"
+# Web server
+gem "puma"
+
+group :development do
+  gem "pry"
+  gem "dotenv-rails"
+end
+```
+
+### Output Gemfile
+```ruby
+source "https://rubygems.org"
+
+# Web server
+gem "puma"
+# Framework
+gem "rails"
+
+group :development do
+  gem "dotenv-rails"
+  gem "pry"
+end
+```
+
+## Development
+To contribute to this project:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/renan-garcia/gem_sorter.git
+   ```
+2. Navigate to the project directory:
+   ```bash
+   cd gem_sorter
+   ```
+3. Install dependencies:
+   ```bash
+   bundle install
+   ```
+4. Run the tests:
+   ```bash
+   rspec
+   ```
+
+## Contributing
+We welcome contributions! Here's how you can help:
+
+1. Fork the repository.
+2. Create a feature branch:
+   ```bash
+   git checkout -b feature/my-new-feature
+   ```
+3. Commit your changes:
+   ```bash
+   git commit -m "Add a new feature"
+   ```
+4. Push to the branch:
+   ```bash
+   git push origin feature/my-new-feature
+   ```
+5. Open a pull request.
+
+## Acknowledgments
+Special thanks to the Ruby community for their guidance and support!

data/lib/gem_sorter/version.rb

@@ -0,0 +1,3 @@
+module GemfileSorter
+  VERSION = '0.1.0'
+end

data/lib/gem_sorter.rb

@@ -0,0 +1,98 @@
+# lib/gem_sorter.rb
+
+load File.expand_path('tasks/gem_sorter.rake', __dir__) if defined?(Rake)
+
+module GemSorter
+  class Sorter
+    def initialize(filepath)
+      @filepath = filepath
+      @content = File.read(filepath)
+    end
+
+    def sort
+      parts = @content.split(/^group/)
+      main_section = parts.shift
+      group_sections = parts
+
+      source_line, gems = process_main_section(main_section)
+
+      sorted_gems = sort_gem_blocks(gems)
+
+      result = []
+      result << source_line
+      result << ''
+      result.concat(sorted_gems)
+      result << ''
+
+      group_sections.each do |section|
+        group_gems = process_group_section(section)
+        result << "group#{section.split("\n").first}"
+        result.concat(sort_gem_blocks(group_gems).map { |line| "  #{line}" })
+        result << 'end'
+        result << ''
+      end
+
+      result.join("\n")
+    end
+
+    private
+
+    def process_main_section(section)
+      lines = section.split("\n").map(&:strip).reject(&:empty?)
+      source_line = lines.shift
+
+      gems = []
+      current_comments = []
+
+      lines.each do |line|
+        if line.start_with?('#')
+          current_comments << line
+        elsif line.start_with?('gem')
+          gems << {
+            comments: current_comments,
+            gem_line: line
+          }
+          current_comments = []
+        end
+      end
+
+      [source_line, gems]
+    end
+
+    def process_group_section(section)
+      lines = section.split("\n").map(&:strip).reject(&:empty?)
+      lines = lines[1...-1]
+
+      gems = []
+      current_comments = []
+
+      lines.each do |line|
+        if line.start_with?('#')
+          current_comments << line
+        elsif line.start_with?('gem')
+          gems << {
+            comments: current_comments,
+            gem_line: line
+          }
+          current_comments = []
+        end
+      end
+
+      gems
+    end
+
+    def sort_gem_blocks(gems)
+      sorted = gems.sort_by do |gem_block|
+        gem_block[:gem_line].match(/gem\s*"([^"]+)"/)[1].downcase
+      end
+
+      result = []
+      sorted.each do |gem_block|
+        result.concat(gem_block[:comments]) unless gem_block[:comments].empty?
+        result << gem_block[:gem_line]
+      end
+
+      result
+    end
+  end
+end

data/lib/tasks/gem_sorter.rake

@@ -0,0 +1,25 @@
+require 'gem_sorter'
+
+namespace :gemfile do
+  desc 'Sort gems in Gemfile alphabetically'
+  task :sort, [:backup] do |_t, args|
+    args.with_defaults(backup: 'false')
+    gemfile_path = 'Gemfile'
+
+    if File.exist?(gemfile_path)
+      if args.backup.downcase == 'true'
+        FileUtils.cp(gemfile_path, "#{gemfile_path}.old")
+        puts 'Original Gemfile backed up as Gemfile.old'
+      end
+
+      sorter = Gem::Sorter.new(gemfile_path)
+      sorted_content = sorter.sort
+
+      File.write(gemfile_path, sorted_content)
+
+      puts 'Gemfile sorted successfully!'
+    else
+      puts 'Error: Gemfile not found in current directory'
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: gem_sorter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Renan Garcia
+bindir: bin
+cert_chain: []
+date: 2025-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple gem to sort the gems in your Gemfile while preserving comments
+  and groups
+email:
+- email@renangarcia.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/gem_sorter.rb
+- lib/gem_sorter/version.rb
+- lib/tasks/gem_sorter.rake
+homepage: https://github.com/renan-garcia/gem_sorter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/renan-garcia/gem_sorter
+  source_code_uri: https://github.com/renan-garcia/gem_sorter
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Sort gems in the Gemfile alphabetically
+test_files: []