Skip to content

Commit d4bd510

Browse files
committed
Update Readme - Add Rspec examples on the documentation.
1 parent e44c0c4 commit d4bd510

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This project contains some examples of how use TDD with Ruby on Rails.
66

77
The main technologies and Rails gems used in this project are:
88

9-
#### Development
9+
### Development
1010
* [Rails 5](http://rubyonrails.org/) - a web-application framework that includes everything needed to create
1111
database-backed web applications according to the Model-View-Controller (MVC) pattern.
1212
* [Devise](https://github.com/plataformatec/devise) - flexible authentication solution for Rails with Warden.
@@ -16,7 +16,7 @@ Sinatra and other Ruby web frameworks.
1616
* [ActiveModelSerializers](https://github.com/rails-api/active_model_serializers) - ActiveModel::Serializer
1717
implementation and Rails hooks.
1818

19-
#### Testing
19+
### Testing
2020
* [Capybara](https://github.com/teamcapybara/capybara) - acceptance test framework for web applications.
2121
* [Rspec](https://github.com/rspec/rspec-rails) - testing framework for Rails 3.x, 4.x and 5.0.
2222
* [Cucumber](https://cucumber.io/) - software tool used by computer programmers for testing other software. It runs
@@ -37,23 +37,42 @@ the behaviour of a real user, and as such interacts with the HTML of the applica
3737
* [Rails Controller Testing](https://github.com/rails/rails-controller-testing) - brings back `assigns` and `assert_template`
3838
to the Rails tests.
3939

40-
#### Database
40+
### Database
4141

4242
As this is a simple application that don't need great data persistence the default database used when a new Ruby on Rails
43-
application is created has been used: [SQlite3](https://www.sqlite.org/)
43+
application is created has been used: [SQlite3](https://www.sqlite.org/).
4444

4545
## Examples
4646

47-
#### String Cauculator - Simple Red Green Refactor sample with Minitest
47+
### String Cauculator - Simple Red Green Refactor example with Minitest
48+
49+
Simple Red Green Refactor example with Minitest.
4850

49-
Simple Red Green Refactor sample with Minitest.
5051
See the [string_calculator.rb](string_calculator.rb) file.
5152

52-
###### Running
53+
##### Running
5354

5455
To run on the root of the project enter:
5556

5657
ruby string_calculator.rb
5758

59+
### RSpec examples
60+
61+
There is many RSpec examples testing examples on this project, for instance 79 specs. All they are running with success.
62+
63+
To run all the specs on the root of the project enter `rspec`.
64+
65+
> There are three specs failing, they are related with the Third API testing with Twitter.
66+
67+
#### Playground - Simple RSpec example
68+
69+
Simple example with RSpec.
70+
71+
See the [playground_spec.rb](spec/playground_spec.rb) and [lib/playground.rb](lib/playground.rb) files.
72+
73+
74+
##### Running
5875

76+
To run on the root of the project enter:
5977

78+
rspec spec/playground_spec.rb

0 commit comments

Comments
 (0)