gem_sorter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a7e010153615999089999a370d116a6404dbdaf855bcb6257c801279baec90b
-  data.tar.gz: 23c131930d94049ad3c90f556fd2e8fc3a7b2c74b3a7eadbed026fb4ef08b333
+  metadata.gz: 91f751af186dcb78cb90b9acbf22c086e895dc6b74ad6b202783fe3f6d799a3d
+  data.tar.gz: dc18ef774b7be132570b526e510c95022b0da490b45fd4483d6ec6ae39a0b1aa
 SHA512:
-  metadata.gz: e0f45801b449beff02390ae7227ef679148214cbf79a96068ef17fa7d668eff14bc7fa64d78309fbeb02e32e9677813adcb96a3371ca2a2d54690b91a26c9022
-  data.tar.gz: 29529cd23267c390d2bafe645a10d612d6f22aca97706157501091952f5266ba3ec735e52f47bdab733318ce41ada18cb28e81230efe091e18702d1f9e8bb59e
+  metadata.gz: 3c527d936237f42547330dc39c740aaca01788a20a3c6e73024ebcddd11dbbce80d74bdeab5d7c39391d7beca6b23264a20fd25e79a1f44c58bb588164ae7238
+  data.tar.gz: 9a640f1ee3d35cd1aa019cea2b9e0eb7898c3d39d0635334660f527073faeea0d5cf860ce5dfc7c90478d8c5f2361b61dbb083621805f95ae153a7900ef85d26

data/README.md

@@ -1,3 +1,7 @@
+<p align="center">
+  <img src="https://i.imgur.com/WHOyL9W.png" width="150" alt="GemSorter Logo">
+</p>
+
 # 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.
@@ -33,9 +37,32 @@ Example:
 ```bash
 rake gemfile:sort[true,true,true]
 ```
-
 This will sort your Gemfile, create a backup, and update comments and versions.
 
+### Options File
+Create a file in the root of your project called `gem_sorter.yml`
+* `backup`: Pass `true` to create a backup of your Gemfile as `Gemfile.old` before sorting.
+* `update_comments`: Pass `true` to update the comments of the gems based on their descriptions.
+* `update_versions`: Pass `true` to update the versions of the gems based on the lockfile.
+* `ignore_gems`: Pass an array of GEMs you want to ignore versions and comments
+* `ignore_gem_versions`: Pass an array of GEMs you want to ignore versions
+* `ignore_gem_comments`: Pass an array of GEMs you want to ignore comments
+
+Example:
+
+```yaml
+backup: true
+update_comments: true
+update_versions: false
+ignore_gems:
+  - byebug
+  - discard
+ignore_gem_versions:
+  - rspec
+ignore_gem_comments:
+  - otpor
+```
+This will sort your Gemfile, create a backup, and update comments and versions.
 ## Example
 ### Input Gemfile
 ```ruby

data/lib/gem_sorter/version.rb

@@ -1,3 +1,3 @@
 module GemSorter
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/gem_sorter.rb

@@ -6,21 +6,22 @@ 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)
+    def initialize(task_config)
+      @config = task_config
+      @filepath = task_config.gemfile_path
+      @content = File.read(task_config.gemfile_path)
       @versions = nil
     end
 
-    def sort(update_comments = false, update_versions = false)
+    def sort
       parts = @content.split(/^group/)
       main_section = parts.shift
       group_sections = parts
 
       source_line, gems = process_main_section(main_section)
 
-      update_gem_summaries(gems) if update_comments
-      update_version_text(gems) if update_versions
+      update_gem_summaries(gems) if @config.update_comments
+      update_version_text(gems) if @config.update_versions
 
       sorted_gems = sort_gem_blocks(gems)
 
@@ -32,8 +33,8 @@ module GemSorter
 
       group_sections.each do |section|
         group_gems = process_group_section(section)
-        update_gem_summaries(group_gems) if update_comments
-        update_version_text(group_gems) if update_versions
+        update_gem_summaries(group_gems) if @config.update_comments
+        update_version_text(group_gems) if @config.update_versions
         result << "group#{section.split("\n").first}"
         result.concat(sort_gem_blocks(group_gems).map { |line| "  #{line}" })
         result << 'end'
@@ -49,6 +50,8 @@ module GemSorter
       @versions ||= fetch_versions_from_lockfile("#{@filepath}.lock")
       gems.each do |gem_block|
         gem_name = gem_block[:gem_line].match(/gem\s*"([^"]+)"/)[1]
+        next if @config.ignore_gems.include?(gem_name) || @config.ignore_gem_versions.include?(gem_name)
+
         version = @versions[gem_name]
         extra_params = extract_params(gem_block[:gem_line])
         base = version ? "#{fetch_gemfile_text(gem_name, version, gem_block[:gem_line])}" : gem_block[:gem_line]
@@ -73,6 +76,8 @@ module GemSorter
     def update_gem_summaries(gems)
       gems.each do |gem_block|
         gem_name = gem_block[:gem_line].match(/gem\s*"([^"]+)"/)[1]
+        next if @config.ignore_gems.include?(gem_name) || @config.ignore_gem_comments.include?(gem_name)
+
         if summary = get_summary(gem_name, false)
           gem_block[:comments] = ["# #{summary}"]
         end

data/lib/task_config.rb

@@ -0,0 +1,94 @@
+require 'yaml'
+
+class GemSorter::TaskConfig
+  attr_reader :backup, :update_comments, :update_versions, :ignore_gems, :gemfile_path
+
+  DEFAULT_CONFIG = {
+    'backup' => false,
+    'update_comments' => false,
+    'update_versions' => false,
+    'gemfile_path' => 'Gemfile',
+    'ignore_gems' => [],
+    'ignore_gem_versions' => [],
+    'ignore_gem_comments' => [],
+  }.freeze
+
+  def initialize(args = nil)
+    @backup = nil
+    @update_comments = nil
+    @update_versions = nil
+    @ignore_gems = nil
+    @ignore_gem_versions = nil
+    @ignore_gem_comments = nil
+    @gemfile_path = nil
+    load_config(args)
+  end
+
+  def backup
+    @backup.nil? ? DEFAULT_CONFIG['backup'] : @backup
+  end
+
+  def update_comments
+    @update_comments.nil? ? DEFAULT_CONFIG['update_comments'] : @update_comments
+  end
+
+  def update_versions
+    @update_versions.nil? ? DEFAULT_CONFIG['update_versions'] : @update_versions
+  end
+
+  def ignore_gems
+    @ignore_gems.nil? ? DEFAULT_CONFIG['ignore_gems'] : @ignore_gems
+  end
+
+  def ignore_gem_versions
+    @ignore_gem_versions.nil? ? DEFAULT_CONFIG['ignore_gem_versions'] : @ignore_gem_versions
+  end
+
+  def ignore_gem_comments
+    @ignore_gem_comments.nil? ? DEFAULT_CONFIG['ignore_gem_comments'] : @ignore_gem_comments
+  end
+
+  def gemfile_path
+    @gemfile_path.nil? ? DEFAULT_CONFIG['gemfile_path'] : @gemfile_path
+  end
+
+  private
+
+  def load_config(args)
+    load_config_from_file
+    load_config_from_args(args)
+  end
+
+  def load_config_from_file
+    if File.exist?(gem_sorter_config_file_path)
+      task_config = YAML.load_file(gem_sorter_config_file_path)
+      @backup = task_config['backup'] if task_config.key?('backup')
+      @update_comments = task_config['update_comments'] if task_config.key?('update_comments')
+      @update_versions = task_config['update_versions'] if task_config.key?('update_versions')
+      @gemfile_path = task_config['gemfile_path'] if task_config.key?('gemfile_path')
+      @ignore_gems = task_config['ignore_gems'] if task_config.key?('ignore_gems')
+      @ignore_gem_versions = task_config['ignore_gem_versions'] if task_config.key?('ignore_gem_versions')
+      @ignore_gem_comments = task_config['ignore_gem_comments'] if task_config.key?('ignore_gem_comments')
+    end
+  end
+
+  def load_config_from_args(args)
+    return unless args
+
+    @backup = parse_boolean(args[:backup]) unless args[:backup].nil?
+    @update_comments = parse_boolean(args[:update_comments]) unless args[:update_comments].nil?
+    @update_versions = parse_boolean(args[:update_versions]) unless args[:update_versions].nil?
+    @gemfile_path = args[:gemfile_path] unless args[:gemfile_path].nil?
+    @ignore_gems = args[:ignore_gems] unless args[:ignore_gems].nil?
+    @ignore_gem_versions = args[:ignore_gem_versions] unless args[:ignore_gem_versions].nil?
+    @ignore_gem_comments = args[:ignore_gem_comments] unless args[:ignore_gem_comments].nil?
+  end
+
+  def parse_boolean(value)
+    value.to_s.downcase == 'true'
+  end
+
+  def gem_sorter_config_file_path
+    'gem_sorter.yml'
+  end
+end

data/lib/tasks/gem_sorter.rake

@@ -1,26 +1,22 @@
 require 'gem_sorter'
+require 'yaml'
+require 'task_config'
 
 namespace :gemfile do
   desc 'Sort gems in Gemfile alphabetically. Options: [backup=true|false] [update_comments=true|false] [update_versions=true|false]'
   task :sort, [:backup, :update_comments, :update_versions] do |_t, args|
-    args.with_defaults(
-      backup: 'false',
-      update_comments: 'false',
-      update_versions: 'false'
-    )
+    task_config = GemSorter::TaskConfig.new(args)
     
-    gemfile_path = 'Gemfile'
-
-    if File.exist?(gemfile_path)
-      if args.backup.downcase == 'true'
-        FileUtils.cp(gemfile_path, "#{gemfile_path}.old")
+    if File.exist?(task_config.gemfile_path)
+      if task_config.backup
+        FileUtils.cp(task_config.gemfile_path, "#{task_config.gemfile_path}.old")
         puts 'Original Gemfile backed up as Gemfile.old'
       end
 
-      sorter = ::GemSorter::Sorter.new(gemfile_path)
-      sorted_content = sorter.sort(args.update_comments.downcase == 'true', args.update_versions.downcase == 'true')
+      sorter = ::GemSorter::Sorter.new(task_config)
+      sorted_content = sorter.sort
 
-      File.write(gemfile_path, sorted_content)
+      File.write(task_config.gemfile_path, sorted_content)
 
       puts 'Gemfile sorted successfully!'
     else

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gem_sorter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Renan Garcia
 bindir: bin
 cert_chain: []
-date: 2025-01-03 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -48,6 +48,7 @@ files:
 - README.md
 - lib/gem_sorter.rb
 - lib/gem_sorter/version.rb
+- lib/task_config.rb
 - lib/tasks/gem_sorter.rake
 homepage: https://github.com/renan-garcia/gem_sorter
 licenses: