rails_architect_analyzer 0.1.0

data/lib/rails_architect/reporters/report_generator.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require "json"
+require "colorize"
+
+module RailsArchitect
+  module Reporters
+    # Generates and formats analysis reports with colorized output
+    class ReportGenerator
+      attr_reader :results
+
+      def initialize(results)
+        @results = results
+      end
+
+      def generate
+        print_header
+        print_architecture_report
+        print_tdd_report
+        print_bdd_report
+        print_solid_report
+        print_summary
+        print_recommendations
+      end
+
+      def to_json(*_args)
+        @results.to_json
+      end
+
+      private
+
+      def print_header
+        puts "\n#{'=' * 80}"
+        puts "🏗️  RAILS ARCHITECT - PROJECT ANALYSIS REPORT".colorize(:blue).bold
+        puts "#{'=' * 80}\n"
+      end
+
+      def print_architecture_report
+        arch = @results[:architecture]
+        puts "📐 ARCHITECTURE ANALYSIS".colorize(:cyan).bold
+        puts "-" * 80
+        puts "Overall Score: #{arch[:score]}%".colorize(:yellow)
+
+        puts "\n✓ Existing Directories (#{arch[:structure].count { |d| d[:exists] }}/#{arch[:structure].count}):"
+        arch[:structure].each do |dir|
+          status = dir[:exists] ? "✅" : "❌"
+          count = dir[:exists] ? " (#{dir[:files_count]} files)" : ""
+          puts "  #{status} #{dir[:name]}#{count}"
+        end
+
+        unless arch[:missing_dirs].empty?
+          puts "\n⚠️  Missing Important Directories:"
+          arch[:missing_dirs].each { |dir| puts "  • #{dir}" }
+        end
+
+        puts "\n📦 Optional Patterns Available:"
+        arch[:optional_dirs].each do |dir|
+          status = dir[:exists] ? "✅ Implemented" : "❌ Not used"
+          puts "  #{status} - #{dir[:description]} (#{dir[:name]})"
+        end
+
+        if arch[:suggestions].any?
+          puts "\n💡 Suggestions:"
+          arch[:suggestions].each { |suggestion| puts "  • #{suggestion}" }
+        end
+
+        puts "\n"
+      end
+
+      def print_tdd_report
+        tdd = @results[:tdd]
+        puts "🧪 TEST-DRIVEN DEVELOPMENT (TDD) ANALYSIS".colorize(:cyan).bold
+        puts "-" * 80
+
+        score_data = tdd[:score]
+        puts "Coverage Score: #{score_data[:score].round(2)}% #{score_data[:rating]}".colorize(score_data[:color])
+
+        puts "\nTest Files:"
+        puts "  • Spec files: #{tdd[:spec_files]}"
+        puts "  • Test files: #{tdd[:test_files]}"
+        puts "  • Total: #{tdd[:spec_files] + tdd[:test_files]}"
+
+        puts "\nTest Structure Breakdown:"
+        tdd[:test_structure].each do |type, counts|
+          puts "  • #{type.capitalize}: #{counts[:total]} files (#{counts[:spec]} specs, #{counts[:test]} tests)"
+        end
+
+        if tdd[:suggestions].any?
+          puts "\n💡 Suggestions:"
+          tdd[:suggestions].each { |suggestion| puts "  • #{suggestion}" }
+        end
+
+        puts "\n"
+      end
+
+      def print_bdd_report
+        bdd = @results[:bdd]
+        puts "🎯 BEHAVIOR-DRIVEN DEVELOPMENT (BDD) ANALYSIS".colorize(:cyan).bold
+        puts "-" * 80
+
+        score_data = bdd[:score]
+        puts "BDD Score: #{score_data[:rating]}".colorize(score_data[:color])
+
+        puts "\nFrameworks:"
+        puts "  • Cucumber: #{bdd[:has_cucumber] ? '✅ Installed' : '❌ Not installed'}"
+        puts "  • RSpec: #{bdd[:has_rspec] ? '✅ Installed' : '❌ Not installed'}"
+
+        puts "\nFeatures & Scenarios:"
+        puts "  • Feature files: #{bdd[:feature_files_count]}"
+        puts "  • Step definitions: #{bdd[:step_definitions_count]}"
+
+        puts "\nBDD Practices:"
+        practices = bdd[:practices]
+        puts "  • User Stories: #{practices[:user_stories] ? '✅ Found' : '❌ Not found'}"
+        scenarios = practices[:readable_scenarios]
+        readable = scenarios[:present] ? "✅ #{scenarios[:count]} found" : "❌ Not found"
+        puts "  • Readable Scenarios: #{readable}"
+        request_specs = practices[:integration_tests][:request_specs]
+        integration_files = practices[:integration_tests][:integration_test_files]
+        puts "  • Integration Tests: #{request_specs + integration_files} files"
+
+        if bdd[:suggestions].any?
+          puts "\n💡 Suggestions:"
+          bdd[:suggestions].each { |suggestion| puts "  • #{suggestion}" }
+        end
+
+        puts "\n"
+      end
+
+      def print_solid_report
+        solid = @results[:solid]
+        puts "⚡ SOLID PRINCIPLES ANALYSIS".colorize(:cyan).bold
+        puts "-" * 80
+
+        score_data = solid[:score]
+        puts "SOLID Score: #{score_data[:score]}/100 #{score_data[:rating]}".colorize(score_data[:color])
+
+        puts "\nPrinciple Analysis:"
+
+        srp = solid[:single_responsibility]
+        puts "\n1. Single Responsibility Principle (SRP)"
+        puts "   Status: #{srp[:status]}".colorize(srp[:status].include?("✅") ? :light_green : :yellow)
+        puts "   Issues found in: #{srp[:issues].join(', ')}" unless srp[:issues].empty?
+
+        ocp = solid[:open_closed]
+        puts "\n2. Open/Closed Principle (OCP)"
+        puts "   Status: #{ocp[:status]}".colorize(ocp[:status].include?("✅") ? :light_green : :yellow)
+        puts "   - Concerns: #{ocp[:has_concerns] ? '✅ Yes' : '❌ No'}"
+        puts "   - Inheritance: #{ocp[:has_inheritance] ? '✅ Used' : '❌ Not used'}"
+
+        lsp = solid[:liskov_substitution]
+        puts "\n3. Liskov Substitution Principle (LSP)"
+        puts "   Status: #{lsp[:status]}".colorize(lsp[:status].include?("✅") ? :light_green : :yellow)
+        puts "   - Inheritance depth: #{lsp[:inheritance_chains]}"
+
+        isp = solid[:interface_segregation]
+        puts "\n4. Interface Segregation Principle (ISP)"
+        puts "   Status: #{isp[:status]}".colorize(isp[:status].include?("✅") ? :light_green : :yellow)
+
+        dip = solid[:dependency_inversion]
+        puts "\n5. Dependency Inversion Principle (DIP)"
+        puts "   Status: #{dip[:status]}".colorize(dip[:status].include?("✅") ? :light_green : :yellow)
+
+        if solid[:suggestions].any?
+          puts "\n💡 Suggestions:"
+          solid[:suggestions].each { |suggestion| puts "  • #{suggestion}" }
+        end
+
+        puts "\n"
+      end
+
+      def print_summary
+        puts "=" * 80
+        puts "📊 OVERALL SUMMARY".colorize(:blue).bold
+        puts "=" * 80
+        puts "\nArchitecture:  #{@results[:architecture][:score]}%".colorize(:light_yellow)
+        tdd_score = @results[:tdd][:score]
+        tdd_str = "TDD Coverage:  #{tdd_score[:score].round(2)}% #{tdd_score[:rating]}"
+        puts tdd_str.colorize(tdd_score[:color])
+        bdd_score = @results[:bdd][:score]
+        puts "BDD Practices: #{bdd_score[:rating]}".colorize(bdd_score[:color])
+        solid_score = @results[:solid][:score]
+        solid_str = "SOLID Score:   #{solid_score[:score]}/100 #{solid_score[:rating]}"
+        puts solid_str.colorize(solid_score[:color])
+        puts "\n"
+      end
+
+      def print_recommendations
+        puts "=" * 80
+        puts "🚀 RECOMMENDATIONS FOR IMPROVEMENT".colorize(:green).bold
+        puts "#{'=' * 80}\n"
+
+        all_suggestions = (
+          @results[:architecture][:suggestions] +
+          @results[:tdd][:suggestions] +
+          @results[:bdd][:suggestions] +
+          @results[:solid][:suggestions]
+        ).uniq
+
+        if all_suggestions.any?
+          all_suggestions.each_with_index do |suggestion, index|
+            puts "#{index + 1}. #{suggestion}"
+          end
+        else
+          puts "✅ Excellent! Your project follows best practices.".colorize(:light_green)
+        end
+
+        puts "\n#{'=' * 80}\n"
+      end
+    end
+  end
+end

data/lib/rails_architect/version.rb

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

data/lib/rails_architect.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails_architect/version"
+require "rails_architect/analyzers/architecture_analyzer"
+require "rails_architect/analyzers/tdd_analyzer"
+require "rails_architect/analyzers/bdd_analyzer"
+require "rails_architect/analyzers/solid_analyzer"
+require "rails_architect/reporters/report_generator"
+require "rails_architect/cli"
+
+# RailsArchitect gem provides comprehensive analysis of Rails projects
+# across architecture, TDD, BDD, and SOLID principles
+module RailsArchitect
+  class Error < StandardError; end
+
+  def self.analyze(project_path = Rails.root)
+    RailsArchitect::Core.new(project_path).analyze
+  end
+end
+
+module RailsArchitect
+  # Core analyzer orchestrating all individual analyzers
+  class Core
+    attr_reader :project_path, :results
+
+    def initialize(project_path = Rails.root)
+      @project_path = project_path
+      @results = {}
+    end
+
+    def analyze
+      puts "🔍 Analyzing Rails Project Architecture...\n".colorize(:blue)
+
+      run_analyzers
+      generate_report
+
+      @results
+    end
+
+    private
+
+    def run_analyzers
+      @results[:architecture] = RailsArchitect::Analyzers::ArchitectureAnalyzer.new(project_path).analyze
+      @results[:tdd] = RailsArchitect::Analyzers::TddAnalyzer.new(project_path).analyze
+      @results[:bdd] = RailsArchitect::Analyzers::BddAnalyzer.new(project_path).analyze
+      @results[:solid] = RailsArchitect::Analyzers::SolidAnalyzer.new(project_path).analyze
+    end
+
+    def generate_report
+      RailsArchitect::Reporters::ReportGenerator.new(@results).generate
+    end
+  end
+end

data/rails_architect.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_architect/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_architect_analyzer"
+  spec.version       = RailsArchitect::VERSION
+  spec.authors       = ["Daniel Matos"]
+  spec.email         = ["eu@danieldjam.dev.br", "danielmatos404@gmail.com"]
+
+  spec.summary       = "Analyze Rails projects for architecture, TDD, BDD, and SOLID principles"
+  spec.description   = "A gem that analyzes your Rails project structure and suggests improvements " \
+                       "based on architecture best practices, TDD, BDD, and SOLID principles."
+  spec.homepage      = "https://github.com/8486/rails_architect"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ast", "~> 2.4"
+  spec.add_dependency "colorize", "~> 0.8"
+  spec.add_dependency "parser", "~> 3.1"
+  spec.add_dependency "rails", ">= 6.0"
+  spec.add_dependency "thor", "~> 1.2"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rails_architect_analyzer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Matos
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A gem that analyzes your Rails project structure and suggests improvements
+  based on architecture best practices, TDD, BDD, and SOLID principles.
+email:
+- eu@danieldjam.dev.br
+- danielmatos404@gmail.com
+executables:
+- rails_architect
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- EXAMPLE_GEMFILE
+- Gemfile
+- INDEX.md
+- LICENSE.md
+- README.md
+- Rakefile
+- exe/rails_architect
+- lib/rails_architect.rb
+- lib/rails_architect/analyzers/architecture_analyzer.rb
+- lib/rails_architect/analyzers/bdd_analyzer.rb
+- lib/rails_architect/analyzers/solid_analyzer.rb
+- lib/rails_architect/analyzers/tdd_analyzer.rb
+- lib/rails_architect/cli.rb
+- lib/rails_architect/reporters/report_generator.rb
+- lib/rails_architect/version.rb
+- rails_architect.gemspec
+homepage: https://github.com/8486/rails_architect
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Analyze Rails projects for architecture, TDD, BDD, and SOLID principles
+test_files: []