cypress-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad072dcc77aecfd321d07b2a747bb72ae7f4bd9f77cd2b6831aad5ae4fac5375
-  data.tar.gz: 9fb63be63a4306b0f13ee3e942e10550ab83136e0abb59dd9e4864faa7e0a352
+  metadata.gz: 9a242d8e71274069fa20fd82ab8aa4ff31eea151ca621b6a36c53e862b3a90a2
+  data.tar.gz: 659cbc0bb3466e15b63ecfe4e951eb867d982325db45e17e7c8df175ffc3c1f9
 SHA512:
-  metadata.gz: 17ee6aa4c845b494ba9ba06599ee07b71a6fc297b9813aa9d3b6949dae4a93d9ea03d8c498395fc759e1906bcb7b38e2f2a17310e852124241d68d0d39bd5eb4
-  data.tar.gz: '09743583af8861b65d4c9512eb6cd0f521bcf76bbe735f904b77924c70c3b8c248d362d95823aa3c3972c94e5376c0481e85f698b496090fe9f4d99c3ed649dd'
+  metadata.gz: ffd03573f5a5d04ed75d760bf76caeaade986c7c0e58b3888212be4df8c17330089bdd251b4366d18aefad8f1a106952f759c27e17b2e54b12f3cd40bcf7dd03
+  data.tar.gz: 3d89d6bb37274c9cab66e72012828d9195125ae80f6e7726493a6d72e94d6d0db5780098988e9c58f91bb476e9d84e056a63d4d374b302efa42e8f46494c12bc

data/.circleci/config.yml

@@ -0,0 +1,52 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6-node-browsers
+    steps:
+      - checkout
+
+      # Bundle install dependencies
+      - type: cache-restore
+        key: v1-main-{{ checksum "Gemfile.lock" }}
+
+      - run: bundle install --path vendor/bundle
+
+      - type: cache-save
+        key: v1-main-{{ checksum "Gemfile.lock" }}
+        paths:
+          - vendor/bundle
+
+      # Bundle install dependencies for example app
+      - type: cache-restore
+        key: v1-example-{{ checksum "example/an_app/Gemfile.lock" }}
+
+      - run: |
+          cd example/an_app
+          bundle install --path vendor/bundle
+
+      - type: cache-save
+        key: v1-example-{{ checksum "example/an_app/Gemfile.lock" }}
+        paths:
+          - example/an_app/vendor/bundle
+
+      # Yarn dependencies
+      - restore_cache:
+          keys:
+            - v1-yarn-{{ checksum "example/an_app/package.json" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-yarn-
+
+      - run: |
+          cd example/an_app
+          yarn install
+
+      - save_cache:
+          paths:
+            - example/an_app/node_modules
+            - ~/.cache
+          key: v1-yarn-{{ checksum "example/an_app/package.json" }}
+
+      - run: bundle exec rake
+      - run: ./script/test_example_app
+

data/.standard.yml

@@ -0,0 +1,4 @@
+ignore:
+  - 'vendor/bundle/**/*'
+  - 'example/an_app/node_modules/**/*'
+  - 'example/an_app/vendor/bundle/**/*'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    cypress-rails (0.0.1)
+    cypress-rails (0.0.2)
+      capybara
       railties (>= 5.2.0)
       selenium-webdriver
 

data/README.md

@@ -1,11 +1,13 @@
 # cypress-rails
 
+[![CircleCI](https://circleci.com/gh/testdouble/cypress-rails/tree/master.svg?style=svg)](https://circleci.com/gh/testdouble/cypress-rails/tree/master)
+
 This is a simple gem to make it easier to start writing browser tests with
-[Cypress](http://cypress.io) for your Rails apps, regardless of whether your app
-is server-side rendered HTML, completely client-side JavaScript, or something in
-between.
+[Cypress](http://cypress.io) for your [Rails](https://rubyonrails.org) apps,
+regardless of whether your app is server-side rendered HTML, completely
+client-side JavaScript, or something in-between.
 
-## Why?
+## Why do this?
 
 Rails ships with a perfectly competent browser-testing facility called [system
 tests](https://guides.rubyonrails.org/testing.html#system-testing) which depend
@@ -19,36 +21,47 @@ additional layers to the Jenga tower of testing facilities that Rails ships
 with? Really, it comes down to the potential for an improved development
 experience. In particular:
 
-* Cypress's IDE-like "open" command provides a highly visual, interactive,
-  inspectable test runner. Not only can you watch each test run and read the
-  commands as they're executed, Cypress takes a DOM snapshot before and after
-  each command, which makes rewinding and inspecting the state of the DOM
-  trivially easy, something that I regularly find myself losing 20 minutes
-  attempting to do with Capybara
-* Cypress "open" enables an almost REPL-like feedback loop that is much faster
+* Cypress's [IDE-like `open`
+  command](https://docs.cypress.io/guides/getting-started/writing-your-first-test.html#Add-a-test-file)
+  provides a highly visual, interactive, inspectable test runner. Not only can
+  you watch each test run and read the commands as they're executed, Cypress
+  takes a DOM snapshot before and after each command, which makes rewinding and
+  inspecting the state of the DOM trivially easy, something that I regularly
+  find myself losing 20 minutes attempting to do with Capybara
+* `cypress open` enables an almost REPL-like feedback loop that is much faster
   and more information dense than using Capybara and Selenium. Rather than
   running a test from the command line, seeing it fail, then adding a debug
   breakpoint to a test to try to manipulate the browser or tweaking a call to a
   Capybara API method, failures to be rather obvious when using Cypress and
   fixing it is usually as easy as tweaking a command, hitting save, and watching
   it re-run
-* Cypress selectors are just jQuery selectors, which makes them both more
-  familiar and more powerful than the CSS and XPath selectors offered by
+* With very few exceptions, a Cypress test that works in a browser window will
+  also pass when run headlessly in CI
+* Cypress selectors are [just jQuery
+  selectors](https://api.jquery.com/category/selectors/), which makes them both
+  more familiar and more powerful than the CSS and XPath selectors offered by
   Capybara. Additionally, Cypress makes it very easy to drop into a plain
-  synchronous JavaScript function for making more complex assertions or
-  composing repetitive tasks into custom commands
+  synchronous JavaScript function for [making more complex
+  assertions](https://docs.cypress.io/guides/references/assertions.html#Should-callback)
+  or composing repetitive tasks into [custom
+  commands](https://docs.cypress.io/api/cypress-api/custom-commands.html#Syntax#article)
 * Cypress commands are, generally, much faster than analogous tasks in Selenium.
   Where certain clicks and form inputs will hang for 300-500ms for seemingly no
   reason when running against Selenium WebDriver, Cypress commands tend to run
   as fast as jQuery can select and fill an element (which is, of course, pretty
   fast)
-* By default, Cypress takes a video of every headless test run, taking a lot of
-  the mystery (and subsequent analysis & debugging) out of test failures in CI
-
-Nevertheless, there are trade-offs (most notably around test data management),
-and I wouldn't recommend adopting Cypress and writing a bunch of browser tests
-for every application. But, if the above points sound like solutions to problems
-you experience, you might consider trying it out.
+* By default, Cypress [takes a
+  video](https://docs.cypress.io/guides/guides/screenshots-and-videos.html#Screenshots#article)
+  of every headless test run, taking a lot of the mystery (and subsequent
+  analysis & debugging) out of test failures in CI
+
+Nevertheless, there are trade-offs to attempting this (most notably around
+Cypress's [limited browser
+support](https://docs.cypress.io/guides/guides/launching-browsers.html#Browsers)
+and the complications to test data management), and I wouldn't recommend
+adopting Cypress and writing a bunch of browser tests for every application.
+But, if the above points sound like solutions to problems you experience, you
+might consider trying it out.
 
 ## Installation
 
@@ -61,7 +74,7 @@ you experience, you might consider trying it out.
 ### Installing Cypress itself
 
 The first step is making sure Cypress is installed (that's up to you, this
-library doesn't install Cypress, it just provides a little Rails specific glue).
+library doesn't install Cypress, it just provides a little Rails-specific glue).
 
 If you're on newer versions of Rails and using
 [webpacker](https://www.github.com/rails/webpacker) for your front-end assets,
@@ -74,7 +87,8 @@ $ yarn add --dev cypress
 
 If you're not using yarn in conjunction with your Rails app, check out the
 Cypress docs on getting it installed. At the end of the day, this gem just needs
-the `cypress` binary to exist someplace it can find.
+the `cypress` binary to exist either in `./node_modules/.bin/cypress` or on your
+`PATH`.
 
 ### Installing the cypress-rails gem
 
@@ -91,7 +105,7 @@ end
 Once installed, you'll want to run:
 
 ```
-$ bin/rake cypress:init
+$ rake cypress:init
 ```
 
 This will override a few configurations in your `cypress.json` configuration
@@ -112,14 +126,14 @@ a wrapper for running `cypress open` with a dedicated Rails test server.
 So, by running either:
 
 ```
-$ bundle exec cypress-rails open
+$ cypress-rails open
 ```
 
 Or, if you don't mind the extra cost of loading rake just so it can call
 `system`:
 
 ```
-$ bin/rake cypress:open
+$ rake cypress:open
 ```
 
 Add tests to `cypress/integration`. Simply click a test file in the Cypress
@@ -132,13 +146,13 @@ To run your tests headlessly (e.g. when you're in CI), you'll want the `run`
 command
 
 ```
-$ bundle exec cypress-rails run
+$ cypress-rails run
 ```
 
 Or, with rake:
 
 ```
-$ bin/rake cypress:run
+$ rake cypress:run
 ```
 
 ### Write Ruby tests that wrap and invoke your cypress tests
@@ -163,15 +177,19 @@ tests need, as well as specifying custom `setup` and `teardown` directives.
 
 Each Cypress file matched by the `test_locator` is translated to a single test
 case, which—while slightly inefficient, as it spools Cypress up and down
-multiple times—also makes it easy to treat each Cypress file as you would any
-other Ruby test, allowing for CLI usage like this:
+multiple times—also makes it easy to handle each Cypress file as you would any
+other Ruby test. It also allows for CLI usage like this (where the test name is
+an expansion of the file location with the path separators replaced with `_`):
 
 ```
-$ bin/rails test test/system --name test_cypress_integration_send_invoice_js
+$ rails test test/system --name test_cypress_integration_send_invoice_js
 ```
 
-(Where the test name is an expansion of the file location with the path
-separators replaced with `_`.)
+**WARNING**: keep in mind that any custom Ruby code you add before or after each
+Cypress test is run in the context of a `CypressRails::TestCase` will _not_ be
+run when developing with `cypress open`! That means this is probably not the
+most rock-solid strategy for consistent test behavior when it comes to things
+like test data management.
 
 ### Setting up continuous integration
 

data/cypress-rails.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.2.0"
+  spec.add_dependency "capybara"
   spec.add_dependency "selenium-webdriver"
 
   spec.add_development_dependency "bundler", "~> 1.17"

data/lib/cypress-rails/version.rb

@@ -1,3 +1,3 @@
 module CypressRails
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/script/test_example_app

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -e
+
+directory=$1
+
+cd example/an_app
+bundle
+yarn install
+bundle exec rake cypress:run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cypress-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-15 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +144,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
+- ".standard.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -152,6 +168,7 @@ files:
 - lib/cypress-rails/starts_rails_server.rb
 - lib/cypress-rails/test_case.rb
 - lib/cypress-rails/version.rb
+- script/test_example_app
 homepage: https://github.com/testdouble/cypress-rails
 licenses:
 - MIT