https://github.com/chubchenko/inquisition
[Work in Progress] A set of tools for convenient technical analysis of web applications built with Ruby and Ruby on Rails. Now you don't need to set up and configure every single gem. Use Inquisition gem instead.
https://github.com/chubchenko/inquisition
code-analysis codebase lint open-source open-source-project opensource ruby-gem ruby-gems ruby-gems-api technical-analysis
Last synced: 4 months ago
JSON representation
[Work in Progress] A set of tools for convenient technical analysis of web applications built with Ruby and Ruby on Rails. Now you don't need to set up and configure every single gem. Use Inquisition gem instead.
- Host: GitHub
- URL: https://github.com/chubchenko/inquisition
- Owner: chubchenko
- License: mit
- Created: 2017-09-21T14:03:16.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2022-09-06T11:31:19.000Z (over 3 years ago)
- Last Synced: 2025-01-29T14:39:07.331Z (about 1 year ago)
- Topics: code-analysis, codebase, lint, open-source, open-source-project, opensource, ruby-gem, ruby-gems, ruby-gems-api, technical-analysis
- Language: Ruby
- Homepage:
- Size: 15.3 MB
- Stars: 61
- Watchers: 7
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://circleci.com/gh/rubygarage/inquisition/tree/develop)
[](https://codeclimate.com/github/rubygarage/inquisition/maintainability)
[](https://codeclimate.com/github/rubygarage/inquisition/test_coverage)
[](http://inch-ci.org/github/rubygarage/inquisition)
## What Inquisition gem is?
Ruby and Ruby on Rails have plenty of tools that help you analyze your codebase quality. However, setting up and configuring every single tool takes too much time. We at RubyGarage decided to save developers' time and create a gem that encompasses all the code analysis tools we use on a daily basis as well as configuration files for each tool and Rake tasks for launching these tools:
* Brakeman - a static analysis security vulnerability scanner for Ruby on Rails applications
* Bullet - a gem that finds and kills N+1 queries and unused eager loading
* Bundler-audit - a patch-level verification for Bundler
* Fasterer - a gem that helps Rubies go faster
* RailRoady - a gem that helps you generate Rails 3/4/5 model (ActiveRecord, Mongoid, Datamapper) and controller UML diagrams
* Rails ERD - a gem that generates Entity-Relationship Diagrams for Rails applications
* Rails_best_practices - a code metric tool for rails projects
* Reek - a code smell detector
* RuboCop - a Ruby static code analyzer and code formatter
The tools are configured for displaying output to the console in a single format which results in better readability and no need to switch between the tools.
The complete list of the tools and links to official repositories can be found in [inquisition.gemspec](https://github.com/rubygarage/inquisition/blob/develop/inquisition.gemspec) file.
If you'd like to check the information regarding each tool, feel free to follow the links.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'inquisition', github: 'rubygarage/inquisition', group: %w(development test)
```
Then execute the following commands:
```bash
$ bundle
$ rails inquisition:install
```
## How to use the Inquisition gem?
By executing the command below, you'll get a list of commands that will allow you to launch either all the tools at a time or launch every single tool separately.
```bash
$ rails --tasks inquisition
```
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
***
RubyGarage is a leading software development and consulting company in Eastern Europe. Our main expertise includes Ruby and Ruby on Rails, but we successfully employ other technologies to deliver the best results to our clients. [Check out our portfolio](https://rubygarage.org/portfolio) for even more exciting works!