rspec-flaky 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68908861a9d1deb8870d2b981c08d3b4d2e35a71c51f73a389ae2be398cbe03d
-  data.tar.gz: be50f21c01defd91ae738ec9d1d19f3ecfe0ee4b606eddfabc241fea0d1843e1
+  metadata.gz: 826e6c22729b3b955a7ca25dc24ea7ba8ff757065e1f3bd9e1ee0d6d16863b84
+  data.tar.gz: 8a762da31ba315fa31e2c23aadcc41af610a924d13340d64fb404695ad59c4b3
 SHA512:
-  metadata.gz: 158aea7d249eae4e938e0d12a2ac898a059a13c8ae32ce41b7fd408c3c781b953306ade0dabacd62c6879c4a1f9176f1d034a080a2c41bb672afdcb1eb98ee50
-  data.tar.gz: f3d2d3b53a66bc4c076b8088a55dca8cd83dc754fbe8fef678f507630fa335ce848e0dba36dfaeb2190483eb095a92e15987c932b07039e022d52a623bcc9791
+  metadata.gz: 977b1809217a067d53ae5bb5bc61159f7fbaf7470166066c40f33fdc4662271afc7ed511987e076661988bb1a27c960b18584f6ae5199d055f56bae64cd10781
+  data.tar.gz: dc8b0ef75a807202c522f1cc9e0b8373542ef13144f5ee7c50a887a74ed6cc86f062bdaffd630dd32ec4eb42902c7c2cc8fba4a321bf69f554b46b57ed8d07dc

data/README.md

@@ -1,38 +1,60 @@
 # RSpecFlaky
 
-TODO: Write a gem description
+The most common reason for test flakiness is randomized factories which fill a database before test execution. This small gem is designed to help you find out what exactly attribute values were assigned to an investigated model during a failed and passed execution.
+
+![image](https://user-images.githubusercontent.com/43433100/106516737-8e72a380-64e8-11eb-9758-34e5cb9f278b.png)
+
 
 ## Installation
 
 Add this line to test group of your application's Gemfile:
 
-    gem 'rspec-flaky'
+```bash
+gem 'rspec-flaky'
+```
 
 Install the gem:
 
-    $ bundle
+```bash
+bundle
+```
+
+That's all. Select the model whose attributes will be dumped:
 
-And then add this line to your spec/spec_helper.rb:
+```ruby
+it 'is flaky test', tables: [User, Post] do
+    expect([true, false]).to be true
+end
+```
+## Usage
 
-    require 'rspec/flaky'
+Run the command to iteratively run flaky example (option `-i` specifies the number of iterations):
 
-Select the model whose attributes will be dumped:
+```bash
+rspec-flaky path/to/flaky_spec.rb:12 -i 5 
+```
 
-    it 'is flaky test', tables: [User, Post] do
-        expect([true, false]).to be true
-    end
+If at least one example is failed gem will generate tables where you are able to investigate source of flakiness by comparing failed and success attribute values. After running your tests, open `tmp/flaky_tests/result.html` in the browser of your choice. For example, in a Mac Terminal, run the following command from your application's root directory:
 
-## Usage
 
-Run the command to iteratively run flaky example:
+```bash
+open tmp/flaky_tests/result.html
+```
+   in a debian/ubuntu Terminal,
+
+```bash
+xdg-open tmp/flaky_tests/result.html
+```
 
-    rspec-flaky path/to/flaky_spec.rb:12 -i 10 -j -d
+   **Note:** [This guide](https://dwheeler.com/essays/open-files-urls.html) can help if you're unsure which command your particular
+   operating system requires.
 
-    -i - iterations number
-    -j - save pointed model attributes to tmp/flaky_tests/.:flaky_spec:12 as json
-    -d - save database dump after each example to tmp/flaky_tests/database_dumps/.:flaky_spec:12 as sql file
 
-If at least one example is failed you can compare pointed model's attributes dumped to tmp/flaky_test folder.
+It's also possible to dump the whole database per each test example if there was a failed result as well as a passed result. For that just add `-d` option (currently only PostresQL is available):
+    
+```
+rspec-flaky path/to/flaky_speЗc.rb:12 -i 10 -d
+```
 
 ## Contributing
 
@@ -40,4 +62,4 @@ If at least one example is failed you can compare pointed model's attributes dum
 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 new Pull Request
+5. Create new Pull Request

data/lib/rspec/flaky/cli.rb

@@ -5,7 +5,7 @@ module Flaky
   class CLI
 
     DEFAULT_OPTIONS = {
-      iterations: 1,
+      iterations: 10,
       silent: false,
       save_jsons: false,
       dump_db: false

data/lib/rspec/flaky/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module RSpecFlaky
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-flaky
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - maratz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashdiff
@@ -45,7 +45,7 @@ files:
 - lib/rspec/flaky/pathes.rb
 - lib/rspec/flaky/tables.rb
 - lib/rspec/flaky/version.rb
-homepage: https://github.com/mzsrn/rspec-flaky
+homepage: https://github.com/RND-SOFT/rspec-flaky
 licenses:
 - MIT
 metadata: {}
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Gem for catching flaky specs