iq-scm / terraforming-rails

Terraforming legacy Rails applications guides and tools

Terraforming Rails

A collection of tools and guides to help you turn legacy code into legendary code.

Based on the RailsConf 2019 talk "Terraforming legacy Rails applications" (slides, video).

Tools

Unreleased scripts

These scripts have been created during the development of different Rails projects at Evil Martians.

They're not universal enough to be extracted into libraries (some depend on particular Rails version or rely on project-specific assumptions), but they could be used a starting point for building tools for your project.

• Lint/Env – RuboCop cop (restrict the usage of ENV and Rails.env in the app)
• FactoryLinter – lint factory definitions
• TimecopLinter – make sure you always travel back in time when using Timecop
• TemplatesTracker – track unused templates
• GemTracker - track potentially unused gems.

Gems

Tests

• TestProf – analyze and improve test suite performance

Security

• bundler-audit – check dependencies for known CVEs
• brakeman – detect the app code's security issues

Database

• database_validations – validations consistent with the DB constraints
• database_consistency - check the consistency of the DB constraints and models validations
• isolator – detect transactions with side-effects (non-atomic)

Dead code elimination

• traceroute – detect unused routes/controller actions
• factory_trace – detect unused FactoryBot factories/traits

Configuration

• anyway_config – transparently use multiple sources of configuration at once

Analysis

• attractor — churn/complexity analysis

Automation Tools

• lefthook – language-agnostic git hook manager
• danger – code review automation helper
• pronto – linters runner to run checks only for the relevant changes

Examples

• CircleCI — example CircleCI configuration files
• Docker for Dev — example Docker for development configuration
• Lefthook + Crystalball — git hooks for convenient development environment

Resources/Guides

• Fight the flaky tests

License

The code is available as open source under the terms of the MIT License.