Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seratch/rspec-kickstarter
RSpec 3 code generator toward existing Ruby code.
https://github.com/seratch/rspec-kickstarter
Last synced: 17 days ago
JSON representation
RSpec 3 code generator toward existing Ruby code.
- Host: GitHub
- URL: https://github.com/seratch/rspec-kickstarter
- Owner: seratch
- License: mit
- Created: 2013-04-25T13:15:03.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-08-14T22:31:52.000Z (about 2 years ago)
- Last Synced: 2024-05-11T18:44:05.619Z (6 months ago)
- Language: Ruby
- Homepage:
- Size: 73.2 KB
- Stars: 128
- Watchers: 5
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# rspec-kickstarter
RSpec 3 code generator toward existing Ruby code. This gem will help you working on existing legacy code which has no tests.
[](https://travis-ci.org/seratch/rspec-kickstarter)
[](https://coveralls.io/r/seratch/rspec-kickstarter)
[](https://codeclimate.com/github/seratch/rspec-kickstarter)
## Installation
https://rubygems.org/gems/rspec-kickstarter
gem install rspec-kickstarter
## Usage
rspec-kickstarter ./app
rspec-kickstarter ./lib
rspec-kickstarter ./lib/yourapp/util.rb
## Options
```
$ rspec-kickstarter -h
Usage: rspec-kickstarter [options]
-f Create if absent or append to the existing spec
--force
-n Dry run mode (shows generated code to console)
--dry-run
-r Run in Rails mode
--rails
-o VAL Output directory (default: ./spec)
--output-dir VAL
-D VAL Delta tempalte path (e.g. ./rails_controller_delta.erb)
--delta-template VAL
-F VAL Full template path (e.g. ./rails_controller_full.erb)
--full-template VAL
-v Print version
--version
```
## Output example
Unfortunately, `lib/foo/bar_baz.rb` has no test. That's too bad...
```ruby
module Foo
class BarBaz
def self.xxx(a, b = "aaa")
end
def yyy()
end
private
def zzz(a)
end
end
end
```
OK, run `rspec-kickstarter` now!
```sh
$ rspec-kickstarter lib/foo/bar_baz.rb
./spec/foo/bar_baz_spec.rb created.
```
`spec/foo/bar_baz_spec.rb` will be created as follows.
```ruby
# -*- encoding: utf-8 -*-
require 'spec_helper'
require 'foo/bar_baz'
describe Foo::BarBaz do
# TODO: auto-generated
describe '#xxx' do
it 'works' do
a = double('a')
b = double('b')
result = Foo::BarBaz.xxx(a, b)
expect(result).not_to be_nil
end
end
# TODO: auto-generated
describe '#yyy' do
it 'works' do
bar_baz = Foo::BarBaz.new
result = bar_baz.yyy()
expect(result).not_to be_nil
end
end
end
```
## Appending lacking test templates
`-f` option allows appending lacking test templates to existing specs.
For instance, `additional_ops` method is added after spec creation.
```ruby
module Foo
class BarBaz
def self.xxx(a, b = "aaa")
end
def yyy()
end
def additional_ops
end
private
def zzz(a)
end
end
end
```
Execute command.
`rspec-kickstarter -f lib/foo/bar_baz.rb`
The following code will be appended.
```ruby
# TODO: auto-generated
describe '#additional_ops' do
it 'works' do
bar_baz = Foo::BarBaz.new
result = bar_baz.additional_ops()
expect(result).not_to be_nil
end
end
end
```
## Rails mode
In Rails mode, rspec-kickstarter generates Rails way spec code for controllers and helpers.
```
$ rspec-kickstarter -r app/controllers/root_controller.rb
```
Output for scaffold:
```ruby
# -*- encoding: utf-8 -*-
require 'rails_helper'
describe CommentsController do
# TODO: auto-generated
describe 'GET index' do
it 'works' do
get :index, {}, {}
expect(response.status).to eq(200)
end
end
# TODO: auto-generated
describe 'GET show' do
it 'works' do
get :show, {}, {}
expect(response.status).to eq(200)
end
end
# TODO: auto-generated
describe 'GET new' do
it 'works' do
get :new, {}, {}
expect(response.status).to eq(200)
end
end
# TODO: auto-generated
describe 'GET edit' do
it 'works' do
get :edit, {}, {}
expect(response.status).to eq(200)
end
end
# TODO: auto-generated
describe 'POST create' do
it 'works' do
post :create, {}, {}
expect(response.status).to eq(200)
end
end
# TODO: auto-generated
describe 'PUT update' do
it 'works' do
put :update, {}, {}
expect(response.status).to eq(200)
end
end
# TODO: auto-generated
describe 'DELETE destroy' do
it 'works' do
delete :destroy, {}, {}
expect(response.status).to eq(200)
end
end
end
```
## Customizable code template
Try the template_samples.
```
ruby -Ilib bin/rspec-kickstarter --delta-template=samples/delta_template.erb --full-template=samples/full_template.erb lib/foo.rb -n
```
When you use customized templates for your apps, `gem install rspec-kickstarter` and do like this:
```
rspec-kickstarter lib -D misc/delta_template.erb -F misc/full_template.erb
```
## RubyKaigi 2013
Lightning talk about rspec-kickstarter at RubyKaigi 2013
http://rubykaigi.org/2013/lightning_talks#seratch
https://speakerdeck.com/seratch/a-test-code-generator-for-rspec-users
## Related Projects
### Vintage fork
https://github.com/ifad/rspec-kickstarter-vintage
This fork supports ruby 1.8.7 and RSpec 1.x with the old syntax.
### ToFactory
https://github.com/markburns/to_factory
ToFactory is a FactoryGirl's factories code generator for existing projects.
## License
Copyright (c) 2013 - Kazuhiro Sera
MIT License
https://github.com/seratch/rspec-kickstarter/blob/master/LICENSE.txt