specify_html_reporter 0.1.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -0
- data/lib/specify_html_reporter/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e01ee43d5cadc3522045c8fe52c3b7b301d906459d8c0b27d7e8ee5bab18f561
|
|
4
|
+
data.tar.gz: f99072e5c019841a9472617bd342e5e43c7d43d73f9bafb8679bd04750e6d18d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 876bfac60a92900ad70579059a155fabc4cbda19f3d1fd5c75cb4a5c8381f000e8dd92b946495aaa46051f98ed7212b898e734501884e36728cfc3551d41860d
|
|
7
|
+
data.tar.gz: ef12c2e216117d01ac86833eae60a6d999b46347ccd1e953bf100c9c5c99ff1c38e74d12ab0d703b2463575bed76d72885ee1b07f20df911e9d88bad3059d6f8
|
data/README.md
CHANGED
|
@@ -53,6 +53,12 @@ If you aren't using an `.rspec` file, just provide `--format SpecifyHtmlReport`
|
|
|
53
53
|
|
|
54
54
|
With the above being done, upon execution of your RSpec suite, you should get a directory called `reports` and within that you'll find an `overview.html` file that serves as the entry point for all reporting. Each spec file is given its own report format and is linked to from the overview file.
|
|
55
55
|
|
|
56
|
+
It is possible to include comments within the reports. See the [comment test](https://github.com/jeffnyman/specify_html_reporter/blob/master/spec/specify_html_reporter/comment_spec.rb) to see how to add comment metadata.
|
|
57
|
+
|
|
58
|
+
You can also include inline specifications, which are effectively special comments that get inserted into the reports. See the [inline test](https://github.com/jeffnyman/specify_html_reporter/blob/master/spec/specify_html_reporter/inline_spec.rb) to see how to add these.
|
|
59
|
+
|
|
60
|
+
It is also possible to embed resources, such as screen grabs and video records, into a report. See the [embedding test](https://github.com/jeffnyman/specify_html_reporter/blob/master/spec/specify_html_reporter/embedding_spec.rb) to see how metadata is used to achieve this effect.
|
|
61
|
+
|
|
56
62
|
## Development
|
|
57
63
|
|
|
58
64
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec:all` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
@@ -85,3 +91,7 @@ To contribute to Specify HTML Reporter:
|
|
|
85
91
|
|
|
86
92
|
Specify HTML Reporter is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
|
|
87
93
|
See the [LICENSE](https://github.com/jeffnyman/specify_html_reporter/blob/master/LICENSE.md) file for details.
|
|
94
|
+
|
|
95
|
+
## Credits
|
|
96
|
+
|
|
97
|
+
This gem is based on original work in [kingsleyh/rspec_reports_formatter](https://github.com/kingsleyh/rspec_reports_formatter) and the modifications provided by [vbanthia/rspec_html_reporter](https://github.com/vbanthia/rspec_html_reporter). The rationale for a new project rather than a fork is I wanted to significantly clean up the code to follow better practices, including fixing a lot of issues with the HTML in the report. Also I plan on extending this very specifically to work with my [Specify](https://github.com/jeffnyman/specify) gem.
|