rails-architect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9eaba9e7a51319c2b9c17d2612aa8937ec9858e3c23cdd22f5293f35c7f0b691
+  data.tar.gz: ec11a0500475321f9941a4e266b77226b692a2eca508b27a9ea47930942ad2dc
+SHA512:
+  metadata.gz: 7a59adc47f124695972d4fc830cffd2e188bdba523071b8e99d1f51e55c9dd30cec9c96c4d3482b872f886720dcb3a678e6952cb62dc5cf913eec787702bad51
+  data.tar.gz: 7ad650cf77b1aef49fb1cc7a84784ecf36394f48472231df1f68150a618cfa258f4b73856fe1294468386ee3fb42d23a8393193096eb90cc784f280aef02f912

data/README.md

@@ -0,0 +1,134 @@
+# RailsArchitect
+
+A comprehensive architectural enforcement and code quality tool for Rails applications.
+
+Rails Architect helps maintain clean Rails architecture by automatically detecting and preventing common anti-patterns, monitoring code complexity, enforcing test coverage, and providing architectural visualizations.
+
+## Features
+
+- **Architecture Pattern Enforcement**: Detects fat models, complex controllers, and suggests service objects
+- **Code Complexity Monitoring**: Tracks method complexity and suggests refactoring
+- **XP/Agile Integration**: Built-in checks for test coverage requirements and TDD patterns
+- **Performance Alerts**: Detects N+1 queries and inefficient database operations
+- **Architecture Visualization**: Generates dependency diagrams and service flow representations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-architect'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install rails-architect
+```
+
+### Configuration
+
+Create `config/rails_architect.yml` in your Rails app:
+
+```yaml
+defaults: &defaults
+  model_method_threshold: 10
+  controller_action_threshold: 5
+  method_complexity_threshold: 10
+  test_coverage_minimum: 80
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+```
+
+### Bullet Integration
+
+Add to your `Gemfile`:
+
+```ruby
+group :development do
+  gem 'bullet'
+end
+```
+
+And configure in `config/environments/development.rb`:
+
+```ruby
+config.after_initialize do
+  Bullet.enable = true
+  Bullet.alert = true
+  Bullet.bullet_logger = true
+  Bullet.console = true
+  Bullet.rails_logger = true
+end
+```
+
+### Pre-commit Hook
+
+Copy the hook to your git hooks:
+
+```bash
+cp $(bundle show rails-architect)/hooks/pre-commit .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit
+```
+
+## Usage
+
+### Command Line
+
+Run analysis on your Rails project:
+
+```bash
+rails-architect analyze    # Run all checks
+rails-architect visualize  # Generate diagrams
+```
+
+### Rake Tasks
+
+```bash
+rake rails_architect:analyze          # Run all checks (fails on issues)
+rake rails_architect:visualize        # Generate visualizations
+rake rails_architect:check_coverage   # Check test coverage
+rake rails_architect:check_performance # Run performance checks
+```
+
+### Programmatic Usage
+
+```ruby
+require 'rails_architect'
+
+# Analyze the codebase
+issues = RailsArchitect.analyze
+issues.each do |issue|
+  puts "#{issue[:type]}: #{issue[:message]} in #{issue[:file]}"
+end
+
+# Generate visualizations
+RailsArchitect.visualize
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/samydghim/rails-architect.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/rails-architect

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rails_architect'
+
+case ARGV[0]
+when 'analyze', nil
+  issues = RailsArchitect.analyze
+  puts "Found #{issues.count} architectural issues:"
+  issues.each { |issue| puts "- #{issue[:message]}" }
+when 'visualize'
+  RailsArchitect.visualize
+else
+  puts "Usage: rails-architect [analyze|visualize]"
+end

data/lib/rails/architect/version.rb

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

data/lib/rails/architect.rb

@@ -0,0 +1,10 @@
+# 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

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

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: rails-architect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sami Dghim
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bullet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- samidghim@gmail.com
+executables:
+- rails-architect
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/rails-architect
+- lib/rails/architect.rb
+- lib/rails/architect/version.rb
+- sig/rails/architect.rbs
+homepage: https://github.com/samydghim/rails-architect
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/samydghim/rails-architect
+  source_code_uri: https://github.com/samydghim/rails-architect
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A comprehensive architectural enforcement and code quality tool for Rails
+test_files: []