Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ndea/regressor

Generate specs for your rails application the easy way. Regressor generates model and controller specs based on validations, associations, enums, database, routes, callbacks. Use regressor to capture your rails application behaviour.
https://github.com/ndea/regressor

generator rspec test-automation

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/ndea/regressor
Owner: ndea
License: mit
Created: 2015-02-17T11:54:50.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2023-04-20T22:46:07.000Z (over 1 year ago)
Last Synced: 2024-10-01T03:41:20.152Z (3 months ago)
Topics: generator, rspec, test-automation
Language: Ruby
Homepage:
Size: 180 KB
Stars: 205
Watchers: 7
Forks: 33
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE

Awesome Lists containing this project

README

[![Gem Version](https://badge.fury.io/rb/regressor.svg)](http://badge.fury.io/rb/regressor)
[![Code Climate](https://codeclimate.com/repos/5506977e6956803f8f003bea/badges/946b605251d8ad324625/gpa.svg)](https://codeclimate.com/repos/5506977e6956803f8f003bea/feed)
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ndea/regressor/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

# Regressor
Regressor is a regression based testing tool.
What is regression testing? [see here](http://en.wikipedia.org/wiki/Regression_testing).
You can generate specs based on your ActiveRecord models.

Made with ♥ at [Qurasoft](http://qurasoft.de)

# Get Regressor
###### Directly from GitHub
```ruby
gem 'regressor', git: 'https://github.com/ndea/regressor.git', branch: 'master'
```
or
###### Rubygems
```ruby
gem 'regressor', '~> 0.6.2'
```

# Install
```bash
bundle install
rails g regressor:install
```
This will create an initializer in config/initializers. This initializers looks like this:
###### Initializer
```ruby
# If the regressor gem is inside a group wrap your initializer in
# if defined?(Regressor) do .. end
Regressor.configure do |config|
# Defines the path where the generated files for your models will be placed
# config.regression_path = 'spec/models/regression'

# Defines the path where the generated files for your controllers will be placed
# config.regression_controller_path = 'spec/controllers/regression'

# Exclude Models for regression spec generation.
# Provide model names as String (e.g. 'User')
# config.excluded_models = []

# Exclude Controllers for regression generation.
# Provide controller names as String (e.g. 'UsersController').
# config.excluded_controllers = []

# If you are using enums in Rails 4 enable this option to generate regression specs for enums.
# If your Rails version is =< Rails 3 set this option to false.
# Default this option is set to true.
# config.include_enums = true
end
```

Then require the gem dependency 'shoulda-matchers' in your rails_helper (or spec_helper if you're using RSpec 2.x):
```ruby
require 'shoulda/matchers'
```

If you are using mongoid please add [mongoid-rspec](https://github.com/mongoid-rspec/mongoid-rspec).

# Usage
###### Run the generator:
Be sure to run the generators in the `test` environment so that `development`-only gems are not being loaded, causing strange issues with controller filters and ActiveRecord callbacks.

##### ActiveRecord
```ruby
RAILS_ENV=test rails generate regressor:model # Create Regression specs for your models
RAILS_ENV=test rails generate regressor:controller # Create Regression specs for your controllers
```
##### Mongoid
```ruby
RAILS_ENV=test rails generate regressor:mongoid:model # Create regression specs for your mongoid models
```

##### Factories
You can even generate empty factories for your models simply by running
```ruby
RAILS_ENV=test rails generate regressor:factory # Create empty factories based on your models
```

##### Supported Regressions
##### Factories
Empty factories can be created.

##### Models

###### ActiveRecord
- Relations
- belongs_to
- has_many
- has_one
- Nested Attributes
- Validations
- Length
- Presence
- Numericality
- Database
- Columns
- Indexes
- Enums (Rails 4)

###### Mongoid
- Relations
- belongs_to
- has_many
- has_one
- embeds_one
- embeds_many
- Database
- Fields
- Document
- Includes
- Versioning

###### Controllers
- Routing
- Callbacks
- Before filter
- After filter
- Around filter

# Also see
[Airpair - Generate specs for your Rails application](https://www.airpair.com/rspec/posts/gert)

[Guard for regressor](https://github.com/patrick-nits/guard-regressor)

# Contributing

1. Fork it ( https://github.com/ndea/regressor/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

# Contribution topics wanted

- Specs
- Documentation
- Bugfixes
- Codestyle
- Anything that improves this gem