isort 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eddd4ac245d4454fae469ae1562f8236c9d273e3d0fbf2197503928267957816
-  data.tar.gz: cc278de73effc6a9e8c69d21b6cb5d2fa06a85542e084d9f93affdedb5bfc169
+  metadata.gz: 6c121d3b6fba0a8fcf8a644eb26ebce0e35b11452cb1a3a644dfbee265a6bd1d
+  data.tar.gz: a80ae99d0f3d627407f7ccdd377365d10412ef9ade8b196b839285cee916a935
 SHA512:
-  metadata.gz: 32a5b91883075031985e3145fee1a321b40e90c8e031288492f53b3faaed65db183b1d3ce1ef6caf8754e3360eeefa94dcfecc2229a4a4d9e96e9f19aec62e02
-  data.tar.gz: 731ea5737a2e677a87b056441349d8fbadc406cefa577e5eeffd424d3a3f522dfb19eea2ca518edf6bedd1bb840d80e51fe4a64099b4e3df5db513ed4ff241ec
+  metadata.gz: 4a92208a0dfd4b76459832abb07ee6878976adfd8c40f8dd249bd330c1d2717e046bd4427a1078a43ff113c3d6adf82b994f3b4dcdf30471f1b1d17a1e54d3d1
+  data.tar.gz: 5ca8c19a71ed5c79135ed98b8f0ca74fe74a7b0ccb22d1de67d93e8fb75192d5f2f69957ab776a231989064a45b966ec2fb9f6a3cea02791acd5740939680635

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## [Unreleased]
+## [Released]
 
 ## [0.1.3] - 2024-12-28
 
@@ -10,3 +10,10 @@
 - Support for require, require_relative, include, and extend statements
 - CLI interface
 - Preservation of code structure and spacing
+
+## [0.1.4] - 2024-12-29
+
+- Second release
+
+### Added
+- Import sorting functionality support for a whole directory

data/README.md

@@ -14,6 +14,8 @@ gem install isort
 
 ```bash
 isort --file path/to/your/file.rb
+or
+isort -f path/to/your/file.rb
 ```
 
 ### In Ruby Code
@@ -35,7 +37,7 @@ sorter.sort_and_format_imports
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/isort.
+Bug reports and pull requests are welcome on GitHub at https://github.com/abhinvv1/isort.
 
 ## License
 

data/lib/isort/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Isort
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/isort.rb

@@ -1,11 +1,9 @@
-# frozen_string_literal: true
-
-require_relative "isort/version"
-
 require 'optparse'
+require_relative "isort/version"
 
 module Isort
   class Error < StandardError; end
+
   class FileSorter
     def initialize(file_path)
       @file_path = file_path
@@ -13,7 +11,7 @@ module Isort
 
     def sort_imports
       # Read the file content
-      lines = File.readlines(@file_path)
+      lines = File.readlines(@file_path, chomp: true).map { |line| line.gsub("\r", "") }
 
       # Separate import-related lines and other content
       imports = lines.select { |line| line =~ /^\s*(require|require_relative|include)\s/ }
@@ -34,12 +32,12 @@ module Isort
       lines = File.readlines(@file_path)
 
       # Separate and group lines
-      requires = extract_lines(lines, /^require\s/)
-      require_relatives = extract_lines(lines, /^require_relative\s/)
-      includes = extract_lines(lines, /^include\s/)
-      extends = extract_lines(lines, /^extend\s/)
-      autoloads = extract_lines(lines, /^autoload\s/)
-      usings = extract_lines(lines, /^using\s/)
+      requires = extract_lines_with_comments(lines, /^require\s/)
+      require_relatives = extract_lines_with_comments(lines, /^require_relative\s/)
+      includes = extract_lines_with_comments(lines, /^include\s/)
+      extends = extract_lines_with_comments(lines, /^extend\s/)
+      autoloads = extract_lines_with_comments(lines, /^autoload\s/)
+      usings = extract_lines_with_comments(lines, /^using\s/)
       others = lines.reject { |line| [requires, require_relatives, includes, extends, autoloads, usings].flatten.include?(line) }
 
       # Format and sort each group
@@ -51,11 +49,16 @@ module Isort
       formatted_imports << format_group("autoload", autoloads)
       formatted_imports << format_group("using", usings)
 
+      return if [requires, require_relatives, includes, extends, autoloads, usings].all?(&:empty?)
+
       # Combine formatted imports with the rest of the file
-      sorted_content = (formatted_imports + others).join
+      sorted_content = "#{formatted_imports.reject(&:empty?).join("\n")}\n#{others.join}".strip
 
-      # Write the sorted content back to the file
-      File.write(@file_path, sorted_content)
+      # Add a trailing newline only if imports exist
+      sorted_content = "#{sorted_content.rstrip}\n" if !formatted_imports.empty? && !sorted_content.empty?
+
+      # Write the sorted content back to the file only if imports exist
+      File.write(@file_path, sorted_content) unless formatted_imports.empty? && sorted_content.empty?
     end
 
     private
@@ -64,13 +67,41 @@ module Isort
       lines.select { |line| line =~ regex }
     end
 
-    def format_group(type, lines)
-      return [] if lines.empty?
+    def extract_lines_with_comments(lines, regex)
+      grouped_lines = []
+      buffer = []
+
+      lines.each do |line|
+        if line.strip.start_with?("#") || line.strip.empty?
+          # If the line is a comment or blank, add it to the buffer
+          buffer << line
+        elsif line =~ regex
+          # If it's an import line matching the regex, attach the buffer as comments
+          grouped_lines << (buffer + [line])
+          buffer = [] # Reset buffer
+        else
+          # If it's a non-matching line, reset the buffer
+          buffer = []
+        end
+      end
+
+      grouped_lines
+    end
+
+    def format_group(type, grouped_lines)
+      return [] if grouped_lines.empty?
 
-      # Remove duplicates and sort
-      lines.uniq.sort
+      # Flatten and sort each group by the import line
+      grouped_lines
+        .sort_by { |lines| lines.last.strip } # Sort by the actual import statement
+        .map { |lines| lines.join }          # Combine comments with the import
+        .map(&:strip)                        # Remove trailing newlines
+        .join("\n")                          # Join all imports in the group with newlines
+        .concat("\n")                        # Add a newline between groups
     end
+
   end
+
   class CLI
     def self.start
       options = {}
@@ -80,12 +111,23 @@ module Isort
         opts.on("-fFILE", "--file=FILE", "File to sort") do |file|
           options[:file] = file
         end
+        opts.on("-dDIRECTORY", "--directory=DIRECTORY", "Specify a directory to sort") do |dir|
+          options[:directory] = dir
+        end
       end.parse!
 
       if options[:file]
         sorter = FileSorter.new(options[:file])
         sorter.sort_and_format_imports
         puts "Imports sorted in #{options[:file]}"
+      elsif options[:directory]
+        count = 0
+        Dir.glob("#{options[:directory]}/**/*.rb").each do |file|
+          count += 1
+          sorter = FileSorter.new(file)
+          sorter.sort_and_format_imports
+        end
+        puts "Sorted imports in #{count} files in directory: #{options[:directory]}"
       else
         puts "Please specify a file using -f or --file"
       end

data/sample.rb

@@ -1,20 +1,4 @@
-require 'csv'
-require 'json'
-require_relative 'a_file'
-require_relative 'b_file'
-include SomeModule
-extend AnotherModule
-autoload :CSV, 'csv'
-using SomeRefinement
-class A
-
-end
-
-
-
-
-
-
-class B
-
-end
+require_relative "aa"
+require_relative "aaaa"
+require_relative "aaaaac"
+require_relative "abc"

data/sig/isort/file_sorter.rbs

@@ -0,0 +1,11 @@
+module Isort
+  class FileSorter
+    @file_path: untyped
+
+    def sort_and_format_imports: -> untyped
+
+    def sort_directory: -> untyped
+
+    def sort_imports: -> untyped
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isort
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - abhinvv1
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-28 00:00:00.000000000 Z
+date: 2024-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -67,7 +67,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Isort automatically sorts and organizes your Ruby imports, including
-  require, require_relative, include, and extend statements
+  require, require_relative, include, using, and extend statements.Has the ability
+  to group different types of imports together. It can process single files or entire
+  directories directly throughcommand-line interface, and preserve the code comments
+  and inline documentation
 email:
 - abhinav.p@browserstack.com
 executables:
@@ -82,18 +85,18 @@ files:
 - README.md
 - Rakefile
 - exe/isort
-- isort-0.1.0.gem
 - lib/isort.rb
 - lib/isort/version.rb
 - sample.rb
 - sig/isort.rbs
-homepage: https://github.com/abhinvv1/sort
+- sig/isort/file_sorter.rbs
+homepage: https://github.com/abhinvv1/isort
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/abhinvv1/sort
-  source_code_uri: https://github.com/abhinvv1/sort
-  changelog_uri: https://github.com/abhinvv1/sort
+  homepage_uri: https://github.com/abhinvv1/isort
+  source_code_uri: https://github.com/abhinvv1/isort
+  changelog_uri: https://github.com/abhinvv1/isort
 post_install_message:
 rdoc_options: []
 require_paths: