rails-architect 0.1.0 → 0.2.0

data/test/rails_app/app/models/report_generator.rb

@@ -0,0 +1,87 @@
+class ReportGenerator
+  # KISS Violation: Overly complex method with nested conditionals
+  # Method complexity exceeds threshold due to multiple control structures
+  def generate_complex_report
+    users = User.all
+    report_data = []
+
+    users.each do |user|
+      user_data = {}
+
+      # Deeply nested conditionals (KISS violation)
+      if user.active?
+        if user.admin?
+          user_data[:role] = 'Administrator'
+          user_data[:permissions] = ['read', 'write', 'delete', 'manage_users']
+        elsif user.moderator?
+          user_data[:role] = 'Moderator'
+          user_data[:permissions] = ['read', 'write', 'delete']
+        else
+          user_data[:role] = 'Member'
+          user_data[:permissions] = ['read', 'write']
+        end
+      else
+        user_data[:status] = 'Inactive'
+        user_data[:permissions] = []
+      end
+
+      # Complex case statement
+      case user.organization.size
+      when 1..10
+        user_data[:org_size] = 'Small'
+      when 11..50
+        user_data[:org_size] = 'Medium'
+      when 51..200
+        user_data[:org_size] = 'Large'
+      else
+        user_data[:org_size] = 'Enterprise'
+      end
+
+      # Multiple loop types in one method (increases complexity)
+      while user.posts.any?
+        post = user.posts.first
+        if post.published?
+          user_data[:published_posts] ||= 0
+          user_data[:published_posts] += 1
+        end
+        break
+      end
+
+      until user.comments.empty?
+        comment = user.comments.first
+        if comment.approved?
+          user_data[:approved_comments] ||= 0
+          user_data[:approved_comments] += 1
+        end
+        break
+      end
+
+      for i in 0..user.posts.count
+        # Some complex logic here
+        break if i > 10
+      end
+
+      report_data << user_data
+    end
+
+    report_data
+  end
+
+  # DRY Violation: Repeated calculation logic
+  def calculate_user_score_v1(user)
+    score = 0
+    score += user.posts.count * 10
+    score += user.comments.count * 5
+    score += user.likes.count * 2
+    score
+  end
+
+  def calculate_user_score_v2(user)
+    score = 0
+    score += user.posts.count * 10
+    score += user.comments.count * 5
+    score += user.likes.count * 2
+    score
+  end
+end
+```

data/test/rails_app/app/models/user.rb

@@ -0,0 +1,79 @@
+class User < ApplicationRecord
+  # Basic validations
+  validates :email, presence: true, uniqueness: true
+  validates :name, presence: true
+
+  # Associations
+  has_many :posts
+  has_many :comments
+  belongs_to :organization
+
+  # Scopes
+  scope :active, -> { where(active: true) }
+  scope :inactive, -> { where(active: false) }
+
+  # SOLID Violation: Too many methods (Fat Model - violates Single Responsibility)
+  # This model has 15+ instance methods doing different things
+  
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+
+  def activate
+    update(active: true)
+  end
+
+  def deactivate
+    update(active: false)
+  end
+
+  def send_welcome_email
+    UserMailer.welcome(self).deliver_later
+  end
+
+  def generate_api_token
+    update(api_token: SecureRandom.hex(20))
+  end
+
+  def posts_count
+    posts.count
+  end
+
+  def comments_count
+    comments.count
+  end
+
+  def recent_posts(limit = 5)
+    posts.order(created_at: :desc).limit(limit)
+  end
+
+  def admin?
+    role == 'admin'
+  end
+
+  def moderator?
+    role == 'moderator'
+  end
+
+  def member?
+    role == 'member'
+  end
+
+  def promote_to_admin
+    update(role: 'admin')
+  end
+
+  def demote_to_member
+    update(role: 'member')
+  end
+
+  # Additional methods to exceed threshold
+  def calculate_reputation
+    posts_count * 5 + comments_count * 2
+  end
+
+  def send_notification(message)
+    # Notification logic
+  end
+end
+```

data/test/rails_app/config/rails_architect.yml

@@ -0,0 +1,14 @@
+defaults: &defaults
+  model_method_threshold: 10
+  controller_action_threshold: 5
+  method_complexity_threshold: 5
+  test_coverage_minimum: 80
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/test/rails_app_integration_test.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class RailsAppIntegrationTest < Minitest::Test
+  def setup
+    @original_dir = Dir.pwd
+    @rails_app_path = File.join(__dir__, 'rails_app')
+  end
+
+  def teardown
+    Dir.chdir(@original_dir)
+  end
+
+  def test_analyzes_dummy_rails_app
+    Dir.chdir(@rails_app_path)
+
+    issues = RailsArchitect.analyze
+
+    # Should find several issues
+    assert issues.size > 0, "Expected to find architectural issues in dummy Rails app"
+
+    # Check for SOLID principle violations
+    solid_srp_issues = issues.select { |i| i[:type] == 'solid_srp' }
+    assert solid_srp_issues.size > 0, "Should detect SOLID SRP violations (fat models/controllers)"
+
+    # Check for KISS violations
+    kiss_complexity_issues = issues.select { |i| i[:type] == 'kiss_complexity' }
+    assert kiss_complexity_issues.size > 0, "Should detect KISS complexity violations"
+
+    # Check for DRY violations
+    dry_issues = issues.select { |i| i[:type].start_with?('dry_') }
+    assert dry_issues.size > 0, "Should detect DRY violations"
+
+    # Verify issue details for SOLID SRP
+    solid_srp_issues.each do |issue|
+      assert issue[:message].include?("Single Responsibility") || issue[:message].include?("extract to service objects"), "Expected SRP-related message, got: #{issue[:message]}"
+    end
+
+    # Verify issue details for KISS
+    kiss_complexity_issues.each do |issue|
+      assert_includes issue[:message], "complexity"
+    end
+
+    # Verify issue details for DRY
+    dry_issues.each do |issue|
+      assert_includes issue[:message], "consider extracting"
+    end
+  end
+end

data/test/rails_architect_test.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class RailsArchitectTest < Minitest::Test
+  def test_analyze_returns_array
+    # Mock the analyzers to avoid file system dependencies
+    mock_checker = Minitest::Mock.new
+    mock_checker.expect :check_models, nil
+    mock_checker.expect :check_controllers, nil
+    mock_checker.expect :issues, []
+
+    mock_complexity = Minitest::Mock.new
+    mock_complexity.expect :analyze, nil
+    mock_complexity.expect :issues, []
+
+    mock_perf_checker = Minitest::Mock.new
+    mock_perf_checker.expect :analyze, nil
+    mock_perf_checker.expect :issues, []
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'rails_architect'
+
+class Minitest::Test
+  def setup
+    # Setup code if needed
+  end
+
+  def teardown
+    # Cleanup code if needed
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-architect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sami Dghim
@@ -121,9 +121,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Rails Architect helps maintain clean Rails architecture by automatically
-  detecting and preventing common anti-patterns, monitoring code complexity, and providing
-  architectural visualizations.
+description: Rails Architect helps maintain clean Rails architecture
 email:
 - samidghim@gmail.com
 executables:
@@ -134,9 +132,24 @@ files:
 - README.md
 - Rakefile
 - bin/rails-architect
-- lib/rails/architect.rb
-- lib/rails/architect/version.rb
-- sig/rails/architect.rbs
+- config/rails_architect.yml
+- lib/rails_architect.rb
+- lib/rails_architect/dry_analyzer.rb
+- lib/rails_architect/kiss_analyzer.rb
+- lib/rails_architect/railtie.rb
+- lib/rails_architect/solid_analyzer.rb
+- lib/rails_architect/tasks/rails_architect.rake
+- lib/rails_architect/version.rb
+- test/rails_app/README.md
+- test/rails_app/app/controllers/posts_controller.rb
+- test/rails_app/app/controllers/users_controller.rb
+- test/rails_app/app/models/post.rb
+- test/rails_app/app/models/report_generator.rb
+- test/rails_app/app/models/user.rb
+- test/rails_app/config/rails_architect.yml
+- test/rails_app_integration_test.rb
+- test/rails_architect_test.rb
+- test/test_helper.rb
 homepage: https://github.com/samydghim/rails-architect
 licenses: []
 metadata:

data/lib/rails/architect/version.rb

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

data/lib/rails/architect.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "architect/version"
-
-module Rails
-  module Architect
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end

data/sig/rails/architect.rbs

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