evil_systems 0.1.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90357ce20a94e7b4c88e4ef6ceee54011abb09b2260e626fd4bf6dccd457e25a
-  data.tar.gz: 83edaa0449bea20e22edafdcaf9b44c262f9d6feea6d68b85fe8b6a30a2db391
+  metadata.gz: f25403b04dfc7644ae7936f3bb5a91412f21c5f789507a39dedf8d12a6ef0ccb
+  data.tar.gz: 721ef96247a864c4873bf3293f57eefcc02049bc2e67b87dab0e0116f16b5b92
 SHA512:
-  metadata.gz: 353035e4a99107279789c22e6166bcc630479aa36515953a46b2e2767190763e663bc8071869162bedd9e42abb87e38df5750ff46c15fb4d8f0438fd880afbf4
-  data.tar.gz: ae4472a0e9ebb755fba01d587dbbc54d979ca893a19bc7c90f7ced39a3ee5bad82d38af5637ceb819fec70f4ce5863be70208a48d619f65236f747e8c5b80293
+  metadata.gz: 65ff0d4dc4c7d7985ea032e8d2171b01f0cd1d1262d381d203813de53e801a885de6eba12e79ff25960faf2743bdc4aebe0bd4bd84e85e1dbf45e8983d94e18c
+  data.tar.gz: e35bffb30e2bdcda404114496c15e6b25c3989ee122cbd3b9e08236249249b4385c0fd699d483cfdd9305f3310b34a9bcbcb6b41b3da19f22a00c30684275953

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 1.1.0
+
+- Feature: add `driver_options` to `initial_setup`
+
+## 1.0.0
+
+- 🚨 BREAKING CHANGE - Renamed `:cuprite` driver to
+`:evil_cuprite` to avoid naming collision in Rails 7.
+<https://github.com/ParamagicDev/evil_systems/pull/7>
+
+- Added `wait_for_network_idle!`
+- Added `:skip_task` to avoid rake tasks all together.
+<https://github.com/evil_systems/pull/8>
+
+- Updated test suite to Rails 7
+
+## 0.2.0
+
+- Disable animations by default @julianrubisch <https://github.com/ParamagicDev/evil_systems/commit/cf72d1189c8bd8b72f130909f209f543a52aaf50>
+
 ## 0.1.3
 
 - Add Slowmo option

data/README.md

@@ -25,28 +25,24 @@ https://rdoc.info/github/paramagicdev/evil_systems/main
 
 ## Installation
 
-```ruby
-# Gemfile
-group :test do
-  gem 'evil_systems', '~> 0.1.0'
-end
+```bash
+bundle add evil_systems --group=test
 ```
 
 Make sure the following 3 gems are in your `Gemfile` as well:
 
 ```ruby
 # Gemfile
-gem 'capybara'
-gem 'cuprite' # Optional
-gem 'selenium-webdriver' # Not required if using Cuprite and using Rails >= 6.1
-```
-
-And then execute:
 
-```bash
-bundle
+group :test do
+  gem 'capybara'
+  gem 'cuprite' # Optional
+  gem 'selenium-webdriver' # Not required if using Cuprite and using Rails >= 6.1
+end
 ```
 
+> Note: `bundle add` by default appends the gem to the bottom of your `Gemfile`, which means not in the `test` group of gems. If the `capybara` gem is in the `test` group, but `evil_systems` is not, you will not be able to load your application in production. Be sure that `evil_systems` is placed in the same group as `capybara` (we recommend the `test` group).
+
 ## Setup
 
 ### Minitest
@@ -67,9 +63,11 @@ require 'capybara/cuprite'
 require 'evil_systems'
 
 EvilSystems.initial_setup
+# To pass in driver_options to cuprite you can do the following:
+# EvilSystems.initial_setup(driver_options: { process_timeout: 20 })
 
 class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
-  driven_by :cuprite
+  driven_by :evil_cuprite
 
   include EvilSystems::Helpers
 end
@@ -83,10 +81,10 @@ end
 
 ## Usage
 
-`EvilSystems.initial_setup` takes two keyword arguments, `:task`, and
-`silent`.
+`EvilSystems.initial_setup` takes three keyword arguments, `:task`, and
+`silent`, `skip_task`.
 
-Both arguments have to do with precompiling assets.
+They all have to do with precompiling assets.
 
 `:silent` by default is set to `true` and will only tell you when assets
 are compiling, and how long the compilation took.
@@ -94,6 +92,8 @@ are compiling, and how long the compilation took.
 `:task` defaults to `assets:precompile`, System of a test uses
 `webpacker:compile`.
 
+`:skip_task` when `true` says you dont want to run any Rake tasks. Default is `false`
+
 Example:
 
 ```rb
@@ -102,11 +102,11 @@ EvilSystems.initial_setup(task: "webpacker:compile", silent: false)
 
 ### Settings
 
-- [x] - Automatically registers a `:cuprite` driver if `Capybara::Cuprite`
+- [x] - Automatically registers a `:evil_cuprite` driver if `Capybara::Cuprite`
 is defined.
 
 - [x] - Automatically sets Capybara's default and javascript driver to
-`:cuprite`
+`:evil_cuprite`
 
 - [x] - Automatically sets `Capybara.app_host`
 
@@ -177,6 +177,9 @@ pause
 # Opens a Pry or IRB repl. Will use Pry if Pry is defined, fallsback
 # to debugging with IRB
 debug binding
+
+# waits to make sure theres no active connections.
+wait_for_network_idle!
 ```
 
 ### Env Variables
@@ -190,6 +193,7 @@ ENV["CHROME_URL"] # used for setting a remote chrome instance for Cuprite
 ENV["PROCESS_TIMEOUT"] # How long to wait before killing the process, default is 5 seconds
 ENV["CI"] # Whether or not to run Cuprite in headless mode, defaults to true.
 ENV["SLOWMO"] # Delay in seconds before sending a command (default 0). Also see https://github.com/rubycdp/ferrum#customization
+ENV["DISABLE_ANIMATION"] # Configure whether Capybara should render animations, default is true
 ```
 
 ## I don't want to use Cuprite.

data/lib/evil_systems/cuprite_helpers.rb

@@ -18,5 +18,11 @@ module EvilSystems
 
       page.driver.pause
     end
+
+    # Convenience method to access the drivers `wait_for_network_idle`
+    # @see https://github.com/rubycdp/cuprite/blob/47d8949f30dea3d97dba70d8643abce861e0d652/README.md#network-traffic
+    def wait_for_network_idle!
+      page.driver.wait_for_network_idle
+    end
   end
 end

data/lib/evil_systems/register_cuprite.rb

@@ -6,10 +6,10 @@ module EvilSystems
   # See https://github.com/rubycdp/cuprite
   module RegisterCuprite
     # Registers the Cuprite driver. Can be used via:
-    # driven_by :cuprite, using: :chrome, screen_size: [1400, 1400]
+    # driven_by :evil_cuprite, using: :chrome, screen_size: [1400, 1400]
     # The initial setup prior to the class ApplicationSystemTestCase, runs before the entire test suite.
     # @return [void]
-    def self.initial_setup
+    def self.initial_setup(driver_options: {})
       return unless defined? Capybara::Cuprite
 
       begin
@@ -20,7 +20,7 @@ module EvilSystems
 
       remote_options = RemoteChrome.options
 
-      ::Capybara.register_driver(:cuprite) do |app|
+      ::Capybara.register_driver(:evil_cuprite) do |app|
         ::Capybara::Cuprite::Driver.new(
           app,
           **{
@@ -30,11 +30,11 @@ module EvilSystems
             process_timeout: process_timeout,
             slowmo: ENV.fetch("SLOWMO", 0).to_f,
             inspector: true
-          }.merge(remote_options)
+          }.merge(remote_options).merge(driver_options)
         )
       end
     end
   end
 end
 
-Capybara.default_driver = Capybara.javascript_driver = :cuprite
+Capybara.default_driver = Capybara.javascript_driver = :evil_cuprite

data/lib/evil_systems/settings.rb

@@ -40,6 +40,9 @@ module EvilSystems
 
       # Where to store artifacts (e.g. screenshots, downloaded files, etc.)
       ::Capybara.save_path = ENV.fetch("CAPYBARA_ARTIFACTS", "./tmp/capybara")
+
+      # Disable animations in Capybara by default
+      ::Capybara.disable_animation = ENV.fetch("DISABLE_ANIMATION", "true") == "true"
     end
 
     private_class_method def self.prepend_session_to_capybara

data/lib/evil_systems/version.rb

@@ -1,3 +1,3 @@
 module EvilSystems
-  VERSION = "0.1.3"
+  VERSION = "1.1.0"
 end

data/lib/evil_systems.rb

@@ -11,9 +11,12 @@ module EvilSystems
   # @see Settings#initial_setup
   # @see RegisterCuprite#initial_setup
   # @see PrecompileAssets#initial_setup
-  def self.initial_setup(task: "assets:precompile", silent: true)
+  def self.initial_setup(task: "assets:precompile", silent: true, skip_task: false)
     Settings.initial_setup
     RegisterCuprite.initial_setup
+
+    return if skip_task
+
     PrecompileAssets.initial_setup(task: task, silent: silent)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evil_systems
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.1.0
 platform: ruby
 authors:
 - ParamagicDev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-description: 
+description:
 email:
 - konnor5456@gmail.com
 executables: []
@@ -80,7 +80,7 @@ metadata:
   homepage_uri: https://github.com/paramagicdev/evil_systems
   source_code_uri: https://github.com/paramagicdev/evil_systems
   changelog_uri: https://github.com/paramagicdev/evil_systems/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Fully integrated setup based on EvilMartians system of a test
 test_files: []