isort 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: eddd4ac245d4454fae469ae1562f8236c9d273e3d0fbf2197503928267957816
4
+ data.tar.gz: cc278de73effc6a9e8c69d21b6cb5d2fa06a85542e084d9f93affdedb5bfc169
5
+ SHA512:
6
+ metadata.gz: 32a5b91883075031985e3145fee1a321b40e90c8e031288492f53b3faaed65db183b1d3ce1ef6caf8754e3360eeefa94dcfecc2229a4a4d9e96e9f19aec62e02
7
+ data.tar.gz: 731ea5737a2e677a87b056441349d8fbadc406cefa577e5eeffd424d3a3f522dfb19eea2ca518edf6bedd1bb840d80e51fe4a64099b4e3df5db513ed4ff241ec
data/.rubocop.yml ADDED
@@ -0,0 +1,8 @@
1
+ AllCops:
2
+ TargetRubyVersion: 3.0
3
+
4
+ Style/StringLiterals:
5
+ EnforcedStyle: double_quotes
6
+
7
+ Style/StringLiteralsInInterpolation:
8
+ EnforcedStyle: double_quotes
data/CHANGELOG.md ADDED
@@ -0,0 +1,12 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.3] - 2024-12-28
4
+
5
+ - Initial release
6
+
7
+ ### Added
8
+ - Initial release
9
+ - Basic import sorting functionality
10
+ - Support for require, require_relative, include, and extend statements
11
+ - CLI interface
12
+ - Preservation of code structure and spacing
@@ -0,0 +1,132 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official email address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [INSERT CONTACT METHOD].
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
+ [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [Mozilla CoC]: https://github.com/mozilla/diversity
131
+ [FAQ]: https://www.contributor-covenant.org/faq
132
+ [translations]: https://www.contributor-covenant.org/translations
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 abhinvv1
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # Isort
2
+
3
+ A Ruby gem that automatically sorts and organizes your import statements in Ruby files.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ gem install isort
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ### Command Line
14
+
15
+ ```bash
16
+ isort --file path/to/your/file.rb
17
+ ```
18
+
19
+ ### In Ruby Code
20
+
21
+ ```ruby
22
+ require 'isort'
23
+
24
+ sorter = Isort::FileSorter.new('path/to/your/file.rb')
25
+ sorter.sort_and_format_imports
26
+ ```
27
+
28
+ ## Features
29
+
30
+ - Sorts require statements alphabetically
31
+ - Groups imports by type (require, require_relative, include, extend)
32
+ - Preserves code structure and spacing
33
+ - Maintains conditional requires
34
+ - Respects nested class and module definitions
35
+
36
+ ## Contributing
37
+
38
+ Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/isort.
39
+
40
+ ## License
41
+
42
+ The gem is available as open source under the terms of the MIT License.
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rubocop/rake_task"
5
+
6
+ RuboCop::RakeTask.new
7
+
8
+ task default: :rubocop
data/exe/isort ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require_relative '../lib/isort'
4
+
5
+ Isort::CLI.start
data/isort-0.1.0.gem ADDED
File without changes
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Isort
4
+ VERSION = "0.1.3"
5
+ end
data/lib/isort.rb ADDED
@@ -0,0 +1,94 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "isort/version"
4
+
5
+ require 'optparse'
6
+
7
+ module Isort
8
+ class Error < StandardError; end
9
+ class FileSorter
10
+ def initialize(file_path)
11
+ @file_path = file_path
12
+ end
13
+
14
+ def sort_imports
15
+ # Read the file content
16
+ lines = File.readlines(@file_path)
17
+
18
+ # Separate import-related lines and other content
19
+ imports = lines.select { |line| line =~ /^\s*(require|require_relative|include)\s/ }
20
+ non_imports = lines.reject { |line| line =~ /^\s*(require|require_relative|include)\s/ }
21
+
22
+ # Sort the import lines alphabetically
23
+ sorted_imports = imports.sort
24
+
25
+ # Combine sorted imports with other lines
26
+ sorted_content = (sorted_imports + non_imports).join
27
+
28
+ # Write the sorted content back to the file
29
+ File.write(@file_path, sorted_content)
30
+ end
31
+
32
+ def sort_and_format_imports
33
+ # Read the file content
34
+ lines = File.readlines(@file_path)
35
+
36
+ # Separate and group lines
37
+ requires = extract_lines(lines, /^require\s/)
38
+ require_relatives = extract_lines(lines, /^require_relative\s/)
39
+ includes = extract_lines(lines, /^include\s/)
40
+ extends = extract_lines(lines, /^extend\s/)
41
+ autoloads = extract_lines(lines, /^autoload\s/)
42
+ usings = extract_lines(lines, /^using\s/)
43
+ others = lines.reject { |line| [requires, require_relatives, includes, extends, autoloads, usings].flatten.include?(line) }
44
+
45
+ # Format and sort each group
46
+ formatted_imports = []
47
+ formatted_imports << format_group("require", requires)
48
+ formatted_imports << format_group("require_relative", require_relatives)
49
+ formatted_imports << format_group("include", includes)
50
+ formatted_imports << format_group("extend", extends)
51
+ formatted_imports << format_group("autoload", autoloads)
52
+ formatted_imports << format_group("using", usings)
53
+
54
+ # Combine formatted imports with the rest of the file
55
+ sorted_content = (formatted_imports + others).join
56
+
57
+ # Write the sorted content back to the file
58
+ File.write(@file_path, sorted_content)
59
+ end
60
+
61
+ private
62
+
63
+ def extract_lines(lines, regex)
64
+ lines.select { |line| line =~ regex }
65
+ end
66
+
67
+ def format_group(type, lines)
68
+ return [] if lines.empty?
69
+
70
+ # Remove duplicates and sort
71
+ lines.uniq.sort
72
+ end
73
+ end
74
+ class CLI
75
+ def self.start
76
+ options = {}
77
+ OptionParser.new do |opts|
78
+ opts.banner = "Usage: sort [options]"
79
+
80
+ opts.on("-fFILE", "--file=FILE", "File to sort") do |file|
81
+ options[:file] = file
82
+ end
83
+ end.parse!
84
+
85
+ if options[:file]
86
+ sorter = FileSorter.new(options[:file])
87
+ sorter.sort_and_format_imports
88
+ puts "Imports sorted in #{options[:file]}"
89
+ else
90
+ puts "Please specify a file using -f or --file"
91
+ end
92
+ end
93
+ end
94
+ end
data/sample.rb ADDED
@@ -0,0 +1,20 @@
1
+ require 'csv'
2
+ require 'json'
3
+ require_relative 'a_file'
4
+ require_relative 'b_file'
5
+ include SomeModule
6
+ extend AnotherModule
7
+ autoload :CSV, 'csv'
8
+ using SomeRefinement
9
+ class A
10
+
11
+ end
12
+
13
+
14
+
15
+
16
+
17
+
18
+ class B
19
+
20
+ end
data/sig/isort.rbs ADDED
@@ -0,0 +1,4 @@
1
+ module Isort
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: isort
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.3
5
+ platform: ruby
6
+ authors:
7
+ - abhinvv1
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2024-12-28 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: optparse
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.2.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.2.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '2.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '13.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '13.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: Isort automatically sorts and organizes your Ruby imports, including
70
+ require, require_relative, include, and extend statements
71
+ email:
72
+ - abhinav.p@browserstack.com
73
+ executables:
74
+ - isort
75
+ extensions: []
76
+ extra_rdoc_files: []
77
+ files:
78
+ - ".rubocop.yml"
79
+ - CHANGELOG.md
80
+ - CODE_OF_CONDUCT.md
81
+ - LICENSE.txt
82
+ - README.md
83
+ - Rakefile
84
+ - exe/isort
85
+ - isort-0.1.0.gem
86
+ - lib/isort.rb
87
+ - lib/isort/version.rb
88
+ - sample.rb
89
+ - sig/isort.rbs
90
+ homepage: https://github.com/abhinvv1/sort
91
+ licenses:
92
+ - MIT
93
+ metadata:
94
+ homepage_uri: https://github.com/abhinvv1/sort
95
+ source_code_uri: https://github.com/abhinvv1/sort
96
+ changelog_uri: https://github.com/abhinvv1/sort
97
+ post_install_message:
98
+ rdoc_options: []
99
+ require_paths:
100
+ - lib
101
+ required_ruby_version: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - ">="
104
+ - !ruby/object:Gem::Version
105
+ version: 2.6.0
106
+ required_rubygems_version: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ requirements: []
112
+ rubygems_version: 3.5.11
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: A Ruby gem for sorting and organizing import statements
116
+ test_files: []