code_polish 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27730de1db7c157ea7410f34802043ddf74b0219a987afd5279f69be5ce3b8d6
+  data.tar.gz: c6ed7b9aa1f13e31d6b0b6b909b4b3d39a9872a2e802b8428d63988091ca9806
+SHA512:
+  metadata.gz: 7bb1ae365081d9e22aca75a1a68fd8ad29811712be72e43627715e024a84aac117fbe45cad12c3016c84ecc0cef8a6cac39a322bf51383bd38bee6c1f404e9f8
+  data.tar.gz: c3dd2ffd792ff042c5a513280d34695264b98b60efa9b36350b70e7bef4678c1ab21c1a85ca3c907cfbd9232e774433e5daf425a5944f5f99872ebff05ed5f01

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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,77 @@
+# CodePolish 🚀
+
+**CodePolish** is a Ruby gem that provides automated code refactoring suggestions to improve code readability and performance.
+
+## 📌 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'code_polish'
+```
+
+Then install it:
+
+```sh
+bundle install
+```
+
+Or install it manually:
+
+```sh
+gem install code_polish
+```
+
+---
+
+## 📖 Usage
+
+To analyze a Ruby file and get refactoring suggestions:
+
+```ruby
+require 'code_polish'
+
+CodePolish::Refactor.analyze_code("path/to/your_file.rb")
+```
+
+For IRB (Interactive Ruby):
+
+```sh
+irb
+```
+```ruby
+require 'code_polish'
+CodePolish::Refactor.analyze_code("example.rb")
+```
+
+---
+
+## 🔖 Versioning
+
+This gem follows **Semantic Versioning (SemVer)**:
+- **Major (`1.0.0`)** → Breaking changes
+- **Minor (`0.2.0`)** → New features
+- **Patch (`0.1.1`)** → Bug fixes
+
+---
+
+## 🤝 Contributing
+
+1. Fork the repository.
+2. Create a new branch: `git checkout -b feature-branch`
+3. Commit your changes: `git commit -m "Added a new feature"`
+4. Push to GitHub: `git push origin feature-branch`
+5. Create a **Pull Request**.
+
+---
+
+## 📝 License
+
+This project is licensed under the **MIT License**. See the `LICENSE` file for details.
+
+---
+
+## 📬 Contact
+
+For issues or feedback, open an issue on [GitHub Issues](https://github.com/rahulkush1/code_polish/issues).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/code_polish/version.rb

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

data/lib/code_polish.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative "code_polish/version"
+
+module CodePolish
+  class Refactor
+    def self.analyze_code(file_or_code)
+      if File.exist?(file_or_code)
+        code = File.read(file_or_code)
+      else
+        code = file_or_code  # Handle direct Ruby code
+      end
+      suggestions = suggest_refactoring(code)
+      puts "Refactoring Suggestions:\n#{suggestions}"
+    end
+
+    private
+
+    def self.suggest_refactoring(code)
+      suggestions = []
+
+      # 1️⃣ Use `map` instead of `each` + `push`
+      suggestions << "Use `map` instead of `each` + `push`" if code.match?(/\.each\s*do\s*\|.*\|\s*.*\.push/)
+
+      # 2️⃣ Use safe navigation operator `&.` for nil checks
+      suggestions << "Use `&.` (safe navigation operator) for nil checks" if code.match?(/if .*\.nil\?/)
+
+      # 3️⃣ Use `empty?` instead of `length == 0`
+      suggestions << "Use `.empty?` instead of `.length == 0`" if code.match?(/\.length\s*==\s*0/)
+
+      # 4️⃣ Use `present?` instead of `!blank?`
+      suggestions << "Use `.present?` instead of `!blank?`" if code.match?(/!\s*.*\.blank\?/)
+
+      # 5️⃣ Use `one?` instead of `select.count == 1`
+      suggestions << "Use `.one?` instead of `.select.count == 1`" if code.match?(/\.select\{.*\}\.count\s*==\s*1/)
+
+      # 6️⃣ Prefer `find_each` over `each` for large data sets
+      suggestions << "Use `.find_each` instead of `.each` for large ActiveRecord queries" if code.match?(/\.each\s*\{\s*\|/)
+
+      # 7️⃣ Avoid `Time.now`, prefer `Time.current` (Rails best practice)
+      suggestions << "Use `Time.current` instead of `Time.now` for Rails apps" if code.match?(/Time\.now/)
+
+      # 8️⃣ Avoid using `eval`, use `send` or `public_send`
+      suggestions << "Avoid `eval`, use `send` or `public_send` instead" if code.match?(/eval\s*\(/)
+
+      # 9️⃣ Avoid `puts` in production code, use `Rails.logger`
+      suggestions << "Use `Rails.logger` instead of `puts` in production code" if code.match?(/puts/)
+
+      # 🔟 Use `String#casecmp?` instead of `.downcase ==`
+      suggestions << "Use `.casecmp?` instead of `.downcase ==` for case-insensitive string comparison" if code.match?(/\.downcase\s*==/)
+
+      # 1️⃣1️⃣ Avoid `select.first`, use `detect` instead
+      suggestions << "Use `.detect` instead of `.select.first`" if code.match?(/\.select\{.*\}\.first/)
+
+      # 1️⃣2️⃣ Avoid using `for` loops, prefer `.each`
+      suggestions << "Avoid `for` loops, use `.each` instead" if code.match?(/for\s+\w+\s+in\s+/)
+
+      # 1️⃣3️⃣ Use `dig` instead of nested hash access
+      suggestions << "Use `.dig` instead of nested hash access" if code.match?(/\[\s*:.*\]\s*\[\s*:.*\]/)
+
+      # 1️⃣4️⃣ Prefer `pluck` over `map(&:attr)` for ActiveRecord
+      suggestions << "Use `.pluck(:attr)` instead of `.map(&:attr)` for ActiveRecord queries" if code.match?(/\.map\(&:\w+\)/)
+
+      # 1️⃣5️⃣ Avoid `each_with_index` when index is not needed
+      suggestions << "Use `.each` instead of `.each_with_index` if index is not used" if code.match?(/\.each_with_index\s*\{.*\|\w+,\s*\|/)
+
+      # 1️⃣6️⃣ Use `!exist?` instead of `nil?` for ActiveRecord
+      suggestions << "Use `!record.exist?` instead of `record.nil?` in ActiveRecord" if code.match?(/\.nil\?\s*&&\s*.*\.exist\?/)
+
+      # 1️⃣7️⃣ Prefer `unless` instead of `if !condition`
+      suggestions << "Use `unless` instead of `if !condition`" if code.match?(/if\s+!\s+/)
+
+      # 1️⃣8️⃣ Use `compact` to remove nil values instead of `select`
+      suggestions << "Use `.compact` instead of `.select { |x| !x.nil? }`" if code.match?(/\.select\s*\{\s*\|.*\|\s*!.*\.nil\?\s*\}/)
+
+      # 1️⃣9️⃣ Use `Array.wrap(value)` instead of `[value].flatten`
+      suggestions << "Use `Array.wrap(value)` instead of `[value].flatten`" if code.match?(/\[.*\]\.flatten/)
+
+      # 2️⃣0️⃣ Prefer `tap` for method chaining instead of `self`
+      suggestions << "Use `.tap` instead of explicit `self` in method chaining" if code.match?(/self\./)
+
+      # 🆕 **Future Enhancements**
+      # ✅ Add more Rails-specific rules
+      # ✅ Add more object-oriented programming (OOP) best practices
+      # ✅ Add performance optimization suggestions
+
+      # AI-based analysis (Optional)
+      if ENV['OPENAI_API_KEY']
+        response = call_openai(code)
+        suggestions << response if response
+      end
+
+      suggestions.empty? ? "No improvements found." : suggestions.join("\n")
+    end
+
+    def self.call_openai(code)
+      require 'openai'
+      client = OpenAI::Client.new(api_key: ENV['OPENAI_API_KEY'])
+
+      response = client.chat(
+        parameters: {
+          model: "gpt-4",
+          messages: [{ role: "user", content: "Suggest refactoring for this Ruby code:\n#{code}" }],
+          temperature: 0.7
+        }
+      )
+
+      response.dig("choices", 0, "message", "content")
+    rescue => e
+      "AI analysis failed: #{e.message}"
+    end
+  end
+end
+

data/sig/code_polish.rbs

@@ -0,0 +1,4 @@
+module CodePolish
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: code_polish
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rahul Kushwaha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-02-05 00:00:00.000000000 Z
+dependencies: []
+description: CodePolish helps developers analyze and refactor Ruby code by detecting
+  common code smells, formatting issues, and performance inefficiencies.
+email:
+- rahulkush2023@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/code_polish.rb
+- lib/code_polish/version.rb
+- sig/code_polish.rbs
+homepage: https://github.com/rahulkush1/code_polish
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rahulkush1/code_polish
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key: 
+specification_version: 4
+summary: A lightweight analysis tool for Ruby.
+test_files: []