rails_unused 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e7471361c7872a42ee5c85d7e417b080c98f2e9a1fafe57f6d5fc3c65481c49
+  data.tar.gz: d61d3a87a5bbf6c8be7e9f25df9787c9e567d51f649a6bd987b8529df125e860
+SHA512:
+  metadata.gz: 9774815714183783f365857e9b0808f9405c3ccb33557d4c3a333606ec640ec68878d018f84c9e0ef5834f3018bc2651f0c1e14eecb6af265e6cb3d272345a8d
+  data.tar.gz: c8ce453bafbf6999ed46823ffd0d88792f9a366e671c8b9ed89f5aa23da0504a5a50c827676a9936a7fafc94fa2ceb6bd6cb0425e36b4456156b220ab79e1186

data/README.md

@@ -0,0 +1,72 @@
+# rails_unused
+
+Dead code analyzer for Ruby on Rails projects.  
+Simple CLI tool that finds unused controllers, models, and services in your Rails app.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'rails_unused'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install rails_unused
+```
+
+## Usage
+
+Inside your Rails project:
+
+```bash
+bundle exec rails_unused
+```
+
+Example output:
+
+```
+Possible unused controllers:
+  - Admin::LegacyController
+
+Possible unused models:
+  - OldCustomer
+
+Possible unused services:
+  - User::CleanupService
+```
+
+## How it works
+
+| Type        | Search logic                                       |
+|-------------|----------------------------------------------------|
+| Controllers | Checks if class name appears in `config/routes.rb` |
+| Models      | Checks if class name is referenced anywhere        |
+| Services    | Checks if class name is referenced anywhere        |
+
+## Limitations
+
+Simple static analysis.
+
+False positives may happen if:
+- Using metaprogramming
+- Dynamic class loading
+- External references
+
+Always review before deleting.
+
+## Roadmap
+
+See [ROADMAP.md](ROADMAP.md) for future improvements.
+
+## Contributing
+
+Pull requests are welcome!

data/ROADMAP.md

@@ -0,0 +1,28 @@
+# Roadmap - rails_unused
+
+## Short term
+
+- Analyze views (partials not rendered anywhere)
+- Detect mailers not being called
+- Check helpers not used in views
+- Support Rails jobs not enqueued
+- Detect unused rake tasks
+
+## Mid term
+
+- Detect unused routes in config/routes.rb
+- Output as JSON or YAML (optional)
+- CI integration to fail build if dead code exists
+- CLI output with colors
+
+## Long term ideas
+
+- Detect unused assets (JS/CSS)
+- Analyze by environment (dev/test/prod)
+- Generate HTML report
+- VSCode Extension
+- Web UI for browsing reports
+
+## Contributions welcome!
+
+Feel free to open issues or send pull requests.

data/exe/rails_unused

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# Este executável permite rodar a análise via CLI: "bundle exec rails_unused"
+
+require 'rails_unused'
+
+RailsUnused.run

data/lib/rails/unused/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  module Unused
+    VERSION = '0.1.0'
+  end
+end

data/lib/rails_unused.rb

@@ -0,0 +1,95 @@
+require_relative 'rails/unused/version'
+
+module RailsUnused
+  class Error < StandardError; end
+
+  def self.run
+    unused_controllers = find_unused_controllers
+    unused_models      = find_unused_models
+    unused_services    = find_unused_services
+
+    puts 'Possíveis controllers não utilizados:'
+    if unused_controllers.empty?
+      puts '  (nenhum controller parece estar sem uso)'
+    else
+      unused_controllers.each { |ctr| puts "  - #{ctr}" }
+    end
+
+    puts "\nPossíveis models não utilizados:"
+    if unused_models.empty?
+      puts '  (nenhum model parece estar sem uso)'
+    else
+      unused_models.each { |mdl| puts "  - #{mdl}" }
+    end
+
+    puts "\nPossíveis services não utilizados:"
+    if unused_services.empty?
+      puts '  (nenhum service parece estar sem uso)'
+    else
+      unused_services.each { |svc| puts "  - #{svc}" }
+    end
+  end
+
+  def self.find_unused_controllers
+    unused = []
+    Dir.glob('app/controllers/**/*_controller.rb').each do |file|
+      content = File.read(file)
+      next unless content =~ /class\s+([A-Za-z0-9_:+]+)/
+
+      controller_class = ::Regexp.last_match(1)
+
+      routes_text = File.exist?('config/routes.rb') ? File.read('config/routes.rb') : ''
+      base_name = controller_class.gsub(/Controller$/, '')
+      unused << controller_class unless routes_text.include?("#{base_name.downcase}#")
+    end
+    unused
+  end
+
+  def self.find_unused_models
+    unused = []
+    all_files = Dir.glob('{app,config,lib}/**/*.rb')
+    Dir.glob('app/models/**/*.rb').each do |file|
+      content = File.read(file)
+      next unless content =~ /class\s+([A-Za-z0-9_:+]+)/
+
+      model_class = ::Regexp.last_match(1).split('<').first.strip
+
+      reference_found = false
+      all_files.each do |f|
+        next if f == file
+
+        text = File.read(f)
+        if text.include?(model_class)
+          reference_found = true
+          break
+        end
+      end
+      unused << model_class unless reference_found
+    end
+    unused
+  end
+
+  def self.find_unused_services
+    unused = []
+    all_files = Dir.glob('{app,config,lib}/**/*.rb')
+    Dir.glob('app/services/**/*.rb').each do |file|
+      content = File.read(file)
+      next unless content =~ /class\s+([A-Za-z0-9_:+]+)/
+
+      service_class = ::Regexp.last_match(1).split('<').first.strip
+
+      reference_found = false
+      all_files.each do |f|
+        next if f == file
+
+        text = File.read(f)
+        if text.include?(service_class)
+          reference_found = true
+          break
+        end
+      end
+      unused << service_class unless reference_found
+    end
+    unused
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rails_unused
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ricardo Grassi
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rails_unused é uma ferramenta CLI que analisa um projeto Ruby on Rails
+  e lista controllers, models e services potencialmente não utilizados no código.
+email:
+- grassiricardorg@gmail.com
+executables:
+- rails_unused
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- ROADMAP.md
+- exe/rails_unused
+- lib/rails/unused/version.rb
+- lib/rails_unused.rb
+homepage: https://github.com/grassiricardo/rails_unused
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Detector de código morto para aplicações Rails
+test_files: []