README.md in rast-0.19.1 vs README.md in rast-1.0.0
- old
+ new
@@ -7,15 +7,15 @@
[](https://codeclimate.com/github/roycetech/rast/test_coverage)
[](https://codeclimate.com/github/roycetech/rast/maintainability)
This library runs on top of RSpec to provide basically a parameterized unit testing pattern. It follows a specific pattern of writing unit tests, enabling a predictable, complete and outputs a result that is simple to analyze.
-### A Basic Example
+## A Basic Example
-Suppose we want to create a class that checks if a number is a positive number or not.
+Suppose we want to create a class that checks if a number is a positive or a negative number.
-#### Create a spec file `spec/positive_spec.rb`
+### Create a spec file `spec/positive_spec.rb`
```ruby
require 'rast'
rast Positive do
@@ -23,15 +23,16 @@
execute { |number| subject.positive?(number) }
end
end
```
-#### Create a spec configuration `spec/rast/positive_spec.yml`
+### Create a spec configuration `spec/rast/positive_spec.yml`
```yaml
+---
specs:
- Is Positive Exaple:
+ Is Positive Example:
variables: {number: [-1, 0, 1]}
outcomes: {true: 1}
```
The class to test:
@@ -59,40 +60,48 @@
Finished in 0.00471 seconds (files took 0.47065 seconds to load)
3 examples, 0 failures
```
-Read the [documentation](./Documentation.md) for more examples.
+See the [documentation](./Documentation.md) for more examples.
+## How to use this project
+1. Run `$ bundle install`
+2. Run `$ bundle exec rspec`
+
+### Troubleshooting
+* Delete the Gemfile.lock and reinstall.
+
+
## Contributing
### Definition of terms
-- `spec` - as defined in the yaml file, the individual elements under `specs`
+- `spec` - as defined in the YAML file, the individual elements under `specs`.
- `scenario` - a specific combination of tokens from vars, it can uniquely identify a fixture.
- `token` - used loosely to denote the individual variable in a rule. e.g. `true: you & me`, `you` and `me` are tokens.
-- `fixture` - a hash containing a scenario, reference back to the spec, and the expected result for the given scenario.
+- `fixture` - a hash containing a scenario, references back to the spec, and the expected result for the given scenario.
- `variables` - raw list of variables to be combined into multiple fixtures.
-- `rule` - set of outcomes, each paired with rule clause.
-- `exclusions` - rule defining variable combinations to be excluded from the test.
+- `rule` - set of outcomes, each paired with a rule clause.
+- `exclusions` - rule defining the variable combinations to be excluded from the test.
- `inclusions` - rule that limits the scenarios to be included. Useful for isolating test cases.
-- `outcome` - the left portion `us` of a rule e.g. `us: you&me`
-- `clause` - the right portion `you&me` of a rule e.g. `us: you&me`
+- `outcome` - the left portion `us` of a rule, e.g. `us: you&me`
+- `clause` - the right portion `you&me` of a rule, e.g. `us: you&me`
## Notes to author
-When running the tests, the execution starts at the spec file, then invoking the
+When running the tests, the execution starts at the spec file, then invokes the
DSL. The DSL will then invoke the parameter generator to generate the scenarios.
### Releasing new features/bugfix
-- Increment the .gemspec
-- Modify the CHANGELOG.md
+- Increment the [.gemspec](./rast.gemspec)
+- Modify the [CHANGELOG.md](./CHANGELOG.md)
-### Releasing GEM
+### Releasing the GEM
- Build gem with `gem build rast.gemspec`
- Publish with `gem push <gem-filename>`
## References
-[Semantic Versioning](https://semver.org)
+* [Semantic Versioning](https://semver.org)