rails_architect_analyzer 0.1.0

data/INDEX.md

@@ -0,0 +1,192 @@
+# 📚 Índice de Documentação - Rails Architect
+
+## 🚀 Primeiros Passos
+
+- **[QUICKSTART.md](QUICKSTART.md)** - Comece em minutos
+  - Instalação simples
+  - Primeiros comandos
+  - Interpretação de resultados
+  - Dicas de início rápido
+
+## 📖 Documentação Principal
+
+- **[README.md](README.md)** - Documentação completa
+  - Características
+  - Instalação detalhada
+  - Uso em linha de comando e código
+  - O que é analisado
+  - Padrões recomendados
+  - Roadmap
+
+- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Guia de contribuição
+  - Como contribuir
+  - Diretrizes
+  - Roadmap
+  - Referências
+
+## 💻 Exemplos e Padrões
+
+- **[REFACTORING_EXAMPLES.md](REFACTORING_EXAMPLES.md)** - Exemplos práticos
+  - Problema 1: Fat Models
+  - Problema 2: Fat Controllers
+  - Problema 3: Dependency Injection
+  - Problema 4: Falta de Testes
+  - Problema 5: DRY com Concerns
+  - Resumo de melhorias
+
+## 📦 Publicação
+
+- **[PUBLISHING.md](PUBLISHING.md)** - Publicar no RubyGems
+  - Configuração de credenciais
+  - Passos de publicação
+  - Checklist
+  - Troubleshooting
+  - Guia de versionamento
+
+## 📝 Histórico
+
+- **[CHANGELOG.md](CHANGELOG.md)** - Histórico de versões
+  - v0.1.0 - Versão inicial
+  - Planejado para futuras versões
+
+## 📋 Código de Conduta
+
+- **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** - Código de conduta
+  - Nossa promessa
+  - Padrões aceitáveis
+  - Responsabilidades
+
+## 🔧 Referência Rápida
+
+### Instalação
+```bash
+gem 'rails_architect'
+bundle install
+```
+
+### Uso
+```bash
+rails_architect analyze           # Análise completa
+rails_architect suggest           # Apenas sugestões
+rails_architect analyze --json --output report.json
+```
+
+### Estrutura do Projeto
+
+```
+rails_architect/
+├── lib/
+│   ├── rails_architect.rb                    # Entrada principal
+│   ├── rails_architect/
+│   │   ├── version.rb                        # Versão
+│   │   ├── cli.rb                           # Interface de linha de comando
+│   │   ├── analyzers/                       # Analisadores
+│   │   │   ├── architecture_analyzer.rb
+│   │   │   ├── tdd_analyzer.rb
+│   │   │   ├── bdd_analyzer.rb
+│   │   │   └── solid_analyzer.rb
+│   │   └── reporters/                       # Geradores de relatórios
+│   │       └── report_generator.rb
+├── exe/
+│   └── rails_architect                      # Executável
+├── spec/
+│   └── rails_architect/
+│       ├── rails_architect_spec.rb
+│       └── analyzers/
+│           └── architecture_analyzer_spec.rb
+├── rails_architect.gemspec                  # Especificação da gem
+├── Gemfile                                  # Dependências
+├── Rakefile                                 # Tasks
+├── README.md
+├── QUICKSTART.md
+├── CONTRIBUTING.md
+├── REFACTORING_EXAMPLES.md
+├── PUBLISHING.md
+├── CODE_OF_CONDUCT.md
+├── CHANGELOG.md
+├── LICENSE.md
+└── .gitignore
+```
+
+### Analisadores Disponíveis
+
+1. **ArchitectureAnalyzer** (`lib/rails_architect/analyzers/architecture_analyzer.rb`)
+   - Valida estrutura padrão Rails
+   - Detecta padrões opcionais
+   - Encontra "fat models" e "fat controllers"
+   - Score: 0-100%
+
+2. **TddAnalyzer** (`lib/rails_architect/analyzers/tdd_analyzer.rb`)
+   - Avalia cobertura de testes
+   - Conta testes por tipo
+   - Estima qualidade TDD
+   - Score: 0-100%
+
+3. **BddAnalyzer** (`lib/rails_architect/analyzers/bdd_analyzer.rb`)
+   - Verifica BDD (Cucumber/RSpec)
+   - Analisa feature files
+   - Valida user stories
+   - Score: 0-100%
+
+4. **SolidAnalyzer** (`lib/rails_architect/analyzers/solid_analyzer.rb`)
+   - Avalia 5 princípios SOLID
+   - Detecta violações
+   - Sugere refatorações
+   - Score: 0-100
+
+### Reportes
+
+**ReportGenerator** (`lib/rails_architect/reporters/report_generator.rb`)
+- Gera relatórios coloridos
+- Exporta para JSON
+- Fornece recomendações
+
+### CLI
+
+**CLI** (`lib/rails_architect/cli.rb`)
+- `analyze` - análise completa
+- `suggest` - apenas sugestões
+- `version` - mostrar versão
+
+## ❓ Dúvidas Frequentes
+
+### Como instalar?
+
+
+### Como usar?
+```bash
+rails_architect analyze
+```
+
+### Como interpretar os scores?
+
+
+### Posso usar em meu projeto Rails?
+Sim! A gem é compatível com Rails 6.0+.
+
+### Como contribuir?
+
+
+### Como publicar?
+
+
+## 🔗 Links Úteis
+
+- **GitHub**: https://github.com/daniel8486/rails_architect
+- **RubyGems**: https://rubygems.org/gems/rails_architect
+- **Issues**: https://github.com/daniel8486/rails_architect/issues
+- **Discussions**: https://github.com/daniel8486/rails_architect/discussions
+
+## 📞 Suporte
+
+- 📧 Email: eu@danieldjam.dev.br | danielmatos404@gmail.com
+- 🐛 Bugs: Abra uma issue no GitHub
+- 💬 Dúvidas: Inicie uma discussão no GitHub
+
+---
+
+**Última atualização:** 8 de dezembro de 2025
+
+**Versão:** 0.1.0
+
+**Licença:** MIT

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 Daniel Matos
+
+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,270 @@
+# Rails Architect
+
+🏗️ Uma gem Ruby para análise completa de projetos Rails com foco em arquitetura, TDD, BDD e princípios SOLID.
+
+## Características
+
+- **📐 Análise de Arquitetura**: Verifica a estrutura padrão do Rails e recomenda padrões opcionais
+- **🧪 Análise TDD**: Avalia cobertura de testes e sugere melhorias
+- **🎯 Análise BDD**: Identifica funcionalidades BDD com Cucumber e RSpec
+- **⚡ Análise SOLID**: Avalia cada princípio SOLID do seu código
+- **💡 Sugestões Inteligentes**: Recomendações específicas para seu projeto
+- **📊 Relatórios Detalhados**: Saída colorida e JSON exportável
+
+## Instalação
+
+Adicione à seu Gemfile:
+
+```ruby
+gem 'rails_architect'
+```
+
+Depois execute:
+
+```bash
+bundle install
+```
+
+## Uso
+
+### Linha de Comando
+
+Analisar seu projeto Rails atual:
+
+```bash
+rails_architect analyze
+```
+
+Analisar um projeto específico:
+
+```bash
+rails_architect analyze /caminho/para/seu/projeto
+```
+
+Obter sugestões de arquitetura:
+
+```bash
+rails_architect suggest
+```
+
+Salvar relatório em JSON:
+
+```bash
+rails_architect analyze --json --output report.json
+```
+
+Salvar relatório em arquivo de texto:
+
+```bash
+rails_architect analyze --output report.txt
+```
+
+### Dentro do Código Rails
+
+```ruby
+# Analisar projeto atual
+results = RailsArchitect.analyze
+
+# Analisar projeto específico
+results = RailsArchitect.analyze('/caminho/para/seu/projeto')
+
+# Acessar resultados específicos
+results[:architecture][:score]      # Score de arquitetura (0-100)
+results[:tdd][:score][:score]       # Score de cobertura TDD
+results[:bdd][:score][:rating]      # Rating de BDD
+results[:solid][:score][:score]     # Score SOLID (0-100)
+```
+
+## O que é Analisado?
+
+### 📐 Arquitetura Rails
+
+- Estrutura padrão de diretórios
+- Padrões opcionais (Services, Decorators, Policies, Presenters, Interactors, etc.)
+- Detecção de "fat models" e "fat controllers"
+- Qualidade de organização de helpers
+
+### 🧪 Test-Driven Development (TDD)
+
+- Cobertura de testes (modelo de estimativa)
+- Número de testes por tipo (models, controllers, services, etc.)
+- Uso de RSpec vs Minitest
+- Sugestões para melhorar cobertura
+
+### 🎯 Behavior-Driven Development (BDD)
+
+- Presença de Cucumber
+- Número de feature files e step definitions
+- Análise de cenários legíveis (Given/When/Then)
+- Testes de integração (request specs)
+
+### ⚡ Princípios SOLID
+
+1. **Single Responsibility**: Detecta classes com múltiplas responsabilidades
+2. **Open/Closed**: Verifica uso de concerns e herança
+3. **Liskov Substitution**: Analisa cadeias de herança
+4. **Interface Segregation**: Detecta módulos e classes muito grandes
+5. **Dependency Inversion**: Avalia uso de service layer e injeção de dependência
+
+## Saída de Exemplo
+
+```
+================================================================================
+🏗️  RAILS ARCHITECT - PROJECT ANALYSIS REPORT
+================================================================================
+
+📐 ARCHITECTURE ANALYSIS
+────────────────────────────────────────────────────────────────────────────────
+Overall Score: 65%
+
+✓ Existing Directories (9/10):
+  ✅ app/models (8 files)
+  ✅ app/controllers (12 files)
+  ✅ app/views (45 files)
+  ...
+
+💡 Suggestions:
+  • Consider creating 'app/services' directory for business logic
+  • Create 'app/decorators' for separating presentation logic from models
+  ...
+
+🧪 TEST-DRIVEN DEVELOPMENT (TDD) ANALYSIS
+────────────────────────────────────────────────────────────────────────────────
+Coverage Score: 45.5% ⚠️  Fair
+
+Test Files:
+  • Spec files: 28
+  • Test files: 0
+  • Total: 28
+
+...
+```
+
+## Configuração
+
+A gem funciona out-of-the-box. Coloque na raiz do seu projeto Rails:
+
+```ruby
+# config/initializers/rails_architect.rb (opcional)
+# Configurações futuras
+```
+
+## Padrões Recomendados
+
+### 1. Services (app/services)
+
+```ruby
+# app/services/user_creator.rb
+class UserCreator
+  def initialize(user_params)
+    @user_params = user_params
+  end
+
+  def call
+    User.create(@user_params)
+  end
+end
+
+# Uso
+UserCreator.new(params).call
+```
+
+### 2. Decorators (app/decorators)
+
+```ruby
+# app/decorators/user_decorator.rb
+class UserDecorator
+  def initialize(user)
+    @user = user
+  end
+
+  def full_name_with_email
+    "#{@user.full_name} <#{@user.email}>"
+  end
+end
+```
+
+### 3. Concerns (app/concerns)
+
+```ruby
+# app/concerns/timestampable.rb
+module Timestampable
+  extend ActiveSupport::Concern
+
+  included do
+    before_save :update_timestamps
+  end
+
+  def update_timestamps
+    self.updated_at = Time.current
+  end
+end
+```
+
+### 4. Policies (app/policies) com Pundit
+
+```ruby
+# app/policies/post_policy.rb
+class PostPolicy
+  def initialize(user, post)
+    @user = user
+    @post = post
+  end
+
+  def update?
+    @user == @post.author
+  end
+end
+```
+
+### 5. Presenters (app/presenters)
+
+```ruby
+# app/presenters/dashboard_presenter.rb
+class DashboardPresenter
+  def initialize(user)
+    @user = user
+  end
+
+  def total_posts
+    @user.posts.count
+  end
+end
+```
+
+## Melhorias Futuras
+
+- [ ] Análise de performance
+- [ ] Detecção de code smells
+- [ ] Sugestões de gems para padrões
+- [ ] Integração com CI/CD
+- [ ] Dashboard web
+- [ ] Comparação entre projetos
+- [ ] Análise histórica
+
+## Contribuindo
+
+1. Faça um fork
+2. Crie uma branch para sua feature (`git checkout -b feature/AmazingFeature`)
+3. Commit suas mudanças (`git commit -m 'Add some AmazingFeature'`)
+4. Push para a branch (`git push origin feature/AmazingFeature`)
+5. Abra um Pull Request
+
+## Licença
+
+MIT License - veja LICENSE.md para detalhes
+
+## Changelog
+
+### v0.1.0
+- Versão inicial com análise de arquitetura, TDD, BDD e SOLID
+- CLI completa com múltiplas opções de saída
+- Relatórios detalhados e coloridos
+
+## Autor
+
+Daniel Matos - [@daniel8486](https://github.com/daniel8486)
+
+## Suporte
+
+Para reportar bugs ou sugerir features, abra uma issue no [GitHub](https://github.com/daniel8486/rails_architect/issues).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Open an IRB session with the gem loaded"
+task :console do
+  require "irb"
+  require "rails_architect"
+  IRB.start(__FILE__)
+end

data/exe/rails_architect

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rails_architect"
+
+RailsArchitect::CLI.start(ARGV)

data/lib/rails_architect/analyzers/architecture_analyzer.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module RailsArchitect
+  module Analyzers
+    # Analyzes Rails project architecture, structure, and design patterns
+    class ArchitectureAnalyzer
+      STANDARD_DIRS = %w[
+        app/models
+        app/controllers
+        app/views
+        app/helpers
+        app/services
+        app/decorators
+        app/policies
+        app/validators
+        config
+        lib
+        spec
+      ].freeze
+
+      attr_reader :project_path
+
+      def initialize(project_path = Rails.root)
+        @project_path = project_path
+      end
+
+      def analyze
+        {
+          score: calculate_score,
+          structure: check_structure,
+          suggestions: generate_suggestions,
+          missing_dirs: missing_directories,
+          optional_dirs: check_optional_dirs
+        }
+      end
+
+      private
+
+      def calculate_score
+        existing = existing_directories.count
+        total = STANDARD_DIRS.count
+        ((existing.to_f / total) * 100).round(2)
+      end
+
+      def check_structure
+        STANDARD_DIRS.map do |dir|
+          full_path = File.join(project_path, dir)
+          {
+            name: dir,
+            exists: File.directory?(full_path),
+            files_count: count_files(full_path)
+          }
+        end
+      end
+
+      def missing_directories
+        STANDARD_DIRS.reject { |dir| File.directory?(File.join(project_path, dir)) }
+      end
+
+      def existing_directories
+        STANDARD_DIRS.select { |dir| File.directory?(File.join(project_path, dir)) }
+      end
+
+      def check_optional_dirs
+        optional = {
+          "app/services" => "Service Objects",
+          "app/decorators" => "Decorator Pattern",
+          "app/policies" => "Authorization Policies",
+          "app/validators" => "Custom Validators",
+          "app/presenters" => "Presenter Pattern",
+          "app/interactors" => "Interactors/Use Cases",
+          "app/concerns" => "Shared Concerns"
+        }
+
+        optional.map do |dir, description|
+          full_path = File.join(project_path, dir)
+          {
+            name: dir,
+            description: description,
+            exists: File.directory?(full_path)
+          }
+        end
+      end
+
+      def generate_suggestions
+        suggestions = []
+
+        if missing_directories.include?("app/services")
+          suggestions << "Consider creating 'app/services' directory for business logic"
+        end
+
+        if missing_directories.include?("app/decorators")
+          suggestions << "Create 'app/decorators' for separating presentation logic from models"
+        end
+
+        if missing_directories.include?("app/policies")
+          suggestions << "Implement 'app/policies' directory for authorization logic (using Pundit)"
+        end
+
+        suggestions << "⚠️  Detected fat models. Consider extracting logic to services or concerns" if fat_models?
+
+        suggestions << "⚠️  Detected fat controllers. Move business logic to services" if fat_controllers?
+
+        if poorly_organized_helpers?
+          suggestions << "Refactor helpers - consider moving logic to presenters or decorators"
+        end
+
+        suggestions
+      end
+
+      def fat_models?
+        models_path = File.join(project_path, "app/models")
+        return false unless File.directory?(models_path)
+
+        Dir.glob(File.join(models_path, "*.rb")).any? do |file|
+          File.readlines(file).count > 200
+        end
+      end
+
+      def fat_controllers?
+        controllers_path = File.join(project_path, "app/controllers")
+        return false unless File.directory?(controllers_path)
+
+        Dir.glob(File.join(controllers_path, "**/*.rb")).any? do |file|
+          File.readlines(file).count > 150
+        end
+      end
+
+      def poorly_organized_helpers?
+        helpers_path = File.join(project_path, "app/helpers")
+        return false unless File.directory?(helpers_path)
+
+        helper_files = Dir.glob(File.join(helpers_path, "*.rb"))
+        helper_files.any? do |file|
+          File.readlines(file).count > 100
+        end
+      end
+
+      def count_files(path)
+        return 0 unless File.directory?(path)
+
+        Dir.glob(File.join(path, "**/*.rb")).count
+      end
+    end
+  end
+end