evil_systems 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40a098c8d111a96295203242dca8c4b3c8c74d9562617964354b190894f8db09
-  data.tar.gz: 8ee1193bc9c323dc8bf82c2668fdad6f182dee7a81a31277ad57d0bb990d8ac4
+  metadata.gz: e260134685b60dd32d198ed9e16d06c951c8efca2a5e7f7839c6f2bd25a513cd
+  data.tar.gz: e46a0563606043cadad08f2ccc9e301f3407120bf5b3c4b15275cba5096e2a78
 SHA512:
-  metadata.gz: 6c159f5a4de7c8d8434e47875fe6d7f639541db4e08f14a934d80af96c533aff29eb3eefd9287fe0114d97b7c3f487cf3b6a090fed4f0c74882f3d93c4f2bb3f
-  data.tar.gz: d5abc78bdbdebf015ec62bcdc0c737f2ffc91002971664cc6424736f065b37db9e48552e0c168f8f4f913294c50ac98d782dcfa07a4e8f7d364d68669e909d29
+  metadata.gz: a94ba44801ac0e86b5c519795b8de8dc8b2f55029df0e11d8228b059675f473d97dc8efec3c022b53b9763a0b5c4fbf9f21fe135a614bcfb7b0769d714434a33
+  data.tar.gz: 81356df72c18b1669bc45b48ff61f118d32a90e48a3a6bd269daedf4c804441116fea2e67cf625982a1e5beb527ce14fd8867cb3422159422a7470ccba1c5f7b

data/README.md

@@ -1,10 +1,23 @@
-# EvilSystemTests
+# Purpose
 
-Why does this exist?
+I write tests using Minitest and routinely reference [EvilMartians System
+of a Test blog post](https://evilmartians.com/chronicles/system-of-a-test-setting-up-end-to-end-rails-testing)
+for Minitest.) on best practices for system tests. In this blog post,
+they also have an opinionated way of setting up System Tests.
 
-I wanted a quick, easy, reusable way to use the settings put forth in
-[EvilMartians System of a Test blog post](https://evilmartians.com/chronicles/system-of-a-test-setting-up-end-to-end-rails-testing)
-for Minitest. System of a test is currently written for RSpec.
+`EvilSystems` offers 3 distinct advantages over the setup provided by
+EvilMartians System of a Test:
+
+1.) The blog post was built with RSpec in mind, but we use Minitest
+here!
+
+2.) Constantly copying 5 files over into every new Rails app is annoying. Lets make that easier!
+
+3.) File changes can end up out of sync, a gem makes sure updates can be
+pushed to all users.
+
+`EvilSystems` is a quick, easy, reusable way to apply the SoaT concepts and settings
+to projects for system tests using Minitest.
 
 Full API documentation can be found here:
 
@@ -12,10 +25,20 @@ https://rdoc.info/github/paramagicdev/evil_systems/main
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```ruby
+# Gemfile
+group :test do
+  gem 'evil_system_tests'
+end
+```
+
+Make sure the following 3 gems are in your `Gemfile` as well:
 
 ```ruby
-gem 'evil_system_tests'
+# Gemfile
+gem 'capybara'
+gem 'selenium-webdriver' # Still required when using Cuprite as of Rails 6.1
+gem 'cuprite' # Optional
 ```
 
 And then execute:
@@ -32,24 +55,23 @@ Navigate to `test/application_system_test_case.rb` in your Rails app.
 
 Setup your file like so:
 
-```diff
+```ruby
 # test/application_system_test_case.rb
 
 require 'test_helper'
 
-+ # 'capybara' and 'capybara/cuprite' need to be defined for EvilSystems to work properly.
-+ require 'capybara'
-+ require 'capybara/cuprite'
+# 'capybara' and 'capybara/cuprite' need to be defined for EvilSystems to work properly.
+require 'capybara'
+require 'capybara/cuprite'
 
-+ require 'evil_systems'
+require 'evil_systems'
 
-+ EvilSystems.initial_setup
+EvilSystems.initial_setup
 
 class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
--  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
-+  driven_by :cuprite
+  driven_by :cuprite
 
-+ include EvilSystems::Helpers
+  include EvilSystems::Helpers
 end
 ```
 
@@ -72,6 +94,12 @@ are compiling, and how long the compilation took.
 `:task` defaults to `assets:precompile`, System of a test uses
 `webpacker:compile`.
 
+Example:
+
+```rb
+EvilSystems.initial_setup(task: "webpacker:compile", silent: false)
+```
+
 ### Settings
 
 - [x] - Automatically registers a `:cuprite` driver if `Capybara::Cuprite`

data/lib/evil_systems/version.rb

@@ -1,3 +1,3 @@
 module EvilSystems
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evil_systems
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - ParamagicDev