cypress-rails 0.1.5 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a314304d580f5b4b1a0e4632fe02ecade86b924240882743a8806185fade30ea
-  data.tar.gz: f88f45fc724e133331239600e65ceb24e62bf6736d92334f7a16be609b17fbd1
+  metadata.gz: c66865f1f844c8e3bd6fc86a881db8059fe26db9ebe70b1eeb0fc05e6ace601a
+  data.tar.gz: b94c1d60432ba1cf738f43574ef5ee9a831a2420cfcc4091446d6c0837860b64
 SHA512:
-  metadata.gz: 457925f6c08058685388d7413d92fc9545b2519e7ca5f21a37f0bc411bb861b7e5f67e5fb5bc58e12b1766462db8bf0b8e59c3cc9b65f5c07553a020a69f4459
-  data.tar.gz: 28e164d2746bc88c2d24cb556a3d67dd9ea487483e913ec0af217c59a8b6f6b8a9993fe90d8e824978cd816900e0b11043a2d7a0aa5ab01779ce3589e9a37fa1
+  metadata.gz: e8878b2be16bd34dbcb4994a0d2cec648dc1fdf41ea88dea4b51092d9e882d7e199dbd189dbc1873f96b3c5834f04df05b08a7592de55b71649cd8f7720e3c07
+  data.tar.gz: 1f200193af7bdddc8e4c56f9d3a3f9b38eeed17fef9e7cd5a26fa0c31b93eb6ba04a4e62b73ed42c5d7c79d6382d9883754311a5a946d4cf8ef00861d1c1d609

data/.circleci/config.yml

@@ -10,6 +10,7 @@ jobs:
       - type: cache-restore
         key: v1-main-{{ checksum "Gemfile.lock" }}
 
+      - run: gem install bundler --version `tail -1 Gemfile.lock`
       - run: bundle install --path vendor/bundle
 
       - type: cache-save
@@ -33,9 +34,9 @@ jobs:
       # Yarn dependencies
       - restore_cache:
           keys:
-            - v2-yarn-{{ checksum "example/an_app/package.json" }}
+            - v4-yarn-{{ checksum "example/an_app/yarn.lock" }}
             # fallback to using the latest cache if no exact match is found
-            - v2-yarn-
+            - v4-yarn-
 
       - run: |
           cd example/an_app
@@ -45,7 +46,7 @@ jobs:
           paths:
             - example/an_app/node_modules
             - ~/.cache
-          key: v2-yarn-{{ checksum "example/an_app/package.json" }}
+          key: v4-yarn-{{ checksum "example/an_app/yarn.lock" }}
 
       - run: bundle exec rake
       - run: ./script/test_example_app

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # CHANGELOG
 
+## 0.4.2
+
+* Add support to Rails 6.1 ([#52](https://github.com/testdouble/cypress-rails/issue/52))
+
+## 0.4.1
+
+* Add backcompat for Ruby 2.4
+  ([#47](https://github.com/testdouble/cypress-rails/pull/47))
+
+## 0.4.0
+
+* Add a `CYPRESS_RAILS_HOST` option that allows a hostname to be specified (as
+opposed to 127.0.0.1). Puma will still bind to 127.0.0.1, but Cypress will use
+the hostname in its `baseUrl`, which may be necessary for some folks' tests to
+work
+
+## 0.3.0
+
+* Add a `CYPRESS_RAILS_BASE_PATH` option which will be appended to the
+  `CYPRESS_BASE_URL` option that cypress-rails sets when launching cypress
+  commands. Apps that set `baseUrl` to something other than "/" can set this env
+  var to match for consistent behavior (or else set it using Cypress.config in a
+  support file)
+
+## 0.2.0
+
+* If `RAILS_ENV` has been explicitly set when the CLI or rake task is run,
+respect that set value instead of overriding it to "test"
+
 ## 0.1.3
 
 * Improve behavior of SIGINT (Ctrl-C) so a traceback isn't printed and stdout

data/Gemfile.lock

@@ -1,55 +1,54 @@
 PATH
   remote: .
   specs:
-    cypress-rails (0.1.5)
+    cypress-rails (0.4.2)
       puma (>= 3.8.0)
       railties (>= 5.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.2.2)
-      actionview (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.0)
+      actionview (= 6.1.0)
+      activesupport (= 6.1.0)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionview (6.1.0)
+      activesupport (= 6.1.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.2.2)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.1)
     builder (3.2.4)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     crass (1.0.6)
-    erubi (1.9.0)
-    i18n (1.8.2)
+    erubi (1.10.0)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    loofah (2.4.0)
+    loofah (2.8.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    nio4r (2.5.2)
-    nokogiri (1.10.9)
+    minitest (5.14.2)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.0.4)
-      ast (~> 2.4.0)
-    puma (4.3.3)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    puma (5.1.1)
       nio4r (~> 2.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -57,33 +56,39 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    railties (6.1.0)
+      actionpack (= 6.1.0)
+      activesupport (= 6.1.0)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      thor (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rubocop (1.4.2)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
-    standard (0.2.1)
-      rubocop (~> 0.79.0)
-      rubocop-performance (~> 1.5.1)
+    standard (0.10.2)
+      rubocop (= 1.4.2)
+      rubocop-performance (= 1.9.1)
     thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.3.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -25,7 +25,7 @@ If you're on newer versions of Rails and using
 then you're likely already using yarn to manage your JavaScript dependencies. If
 that's the case, you can add Cypress with:
 
-```
+```sh
 $ yarn add --dev cypress
 ```
 
@@ -40,7 +40,7 @@ Now, to install the cypress-rails gem, you'll want to add it to your development
 & test gem groups of your Gemfile, so that you have easy access to its rake
 tasks:
 
-``` ruby
+```ruby
 group :development, :test do
   gem "cypress-rails"
 end
@@ -48,7 +48,7 @@ end
 
 Once installed, you'll want to run:
 
-```
+```sh
 $ rake cypress:init
 ```
 
@@ -69,7 +69,7 @@ a wrapper for running `cypress open` with a dedicated Rails test server.
 
 So, by running:
 
-```
+```sh
 $ rake cypress:open
 ```
 
@@ -83,7 +83,7 @@ itself.
 To run your tests headlessly (e.g. when you're in CI), you'll want the `run`
 command:
 
-```
+```sh
 $ rake cypress:run
 ```
 
@@ -102,7 +102,7 @@ like:
 return unless Rails.env.test?
 
 CypressRails.hooks.before_server_start do
-  # Called once, before ether the transaction or the server is started
+  # Called once, before either the transaction or the server is started
 end
 
 CypressRails.hooks.after_transaction_start do
@@ -138,9 +138,9 @@ This way, you can easily instruct the server to reset its test state from your
 Cypress tests like so:
 
 ```js
-beforeEach(() =>
+beforeEach(() => {
   cy.request('/cypress_rails_reset_state')
-)
+})
 ```
 
 (Remember, in Cypress, `before` is a before-all hook and `beforeEach` is run
@@ -158,8 +158,13 @@ preferred environment variables project-wide using a tool like
 
 
 * **CYPRESS_RAILS_DIR** (default: `Dir.pwd`) the directory of your project
+* **CYPRESS_RAILS_HOST** (default: `"127.0.0.1"`) the hostname to bind to
 * **CYPRESS_RAILS_PORT** (default: _a random available port_) the port to run
   the Rails test server on
+* **CYPRESS_RAILS_BASE_PATH** (default: `"/"`) the base path for all Cypress's
+  requests to the app (e.g. via `cy.visit()`). If you've customized your
+  `baseUrl` setting (e.g. in `cypress.json`), you'll need to duplicate it with
+  this environment variable
 * **CYPRESS_RAILS_TRANSACTIONAL_SERVER** (default: `true`) when true, will start
   a transaction on all database connections before launching the server. In
   general this means anything done during `cypress open` or `cypress run` will
@@ -167,6 +172,15 @@ preferred environment variables project-wide using a tool like
 * **CYPRESS_RAILS_CYPRESS_OPTS** (default: _none_) any options you want to
   forward to the Cypress CLI when running its `open` or `run` commands
 
+#### Example: Running a single spec from the command line
+
+It's a little verbose, but an example of using the above options to run a single
+Cypress test would look like this:
+
+```
+$ CYPRESS_RAILS_CYPRESS_OPTS="--spec cypress/integration/a_test.js" bin/rake cypress:run
+```
+
 ### Initializer hooks
 
 ### before_server_start
@@ -198,6 +212,22 @@ pollute other test suites or scripts, you can use the `before_server_stop` to
 of your test database. To set up the hook, pass a block to
 `CypressRails.hooks.before_server_stop`.
 
+## Configuring Rails
+
+Beyond the configuration options above, you'll probably also want to disable caching
+in your Rails app's [config/environments/test.rb](/example/an_app/config/environments/test.rb#L9)
+file, so that changes to your Ruby code are reflected in your tests while you
+work on them with `rake cypress:open`. (If either option is set to
+`true`, any changes to your Ruby code will require a server restart to be reflected as you work
+on your tests.)
+
+To illustrate, here's what that might look like in `config/environments/test.rb`:
+
+```ruby
+config.cache_classes = false
+config.action_view.cache_template_loading = false
+```
+
 ## Setting up continuous integration
 
 #### Circle CI
@@ -233,7 +263,7 @@ jobs:
       # Yarn dependencies
       - restore_cache:
           keys:
-            - v1-yarn-{{ checksum "package.json" }}
+            - v1-yarn-{{ checksum "yarn.lock" }}
             # fallback to using the latest cache if no exact match is found
             - v1-yarn-
 
@@ -243,7 +273,7 @@ jobs:
           paths:
             - node_modules
             - ~/.cache
-          key: v1-yarn-{{ checksum "package.json" }}
+          key: v1-yarn-{{ checksum "yarn.lock" }}
 
       # Run your cypress tests
       - run: bin/rake cypress:run
@@ -305,5 +335,12 @@ 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.
 
+## Code of Conduct
 
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+including (but not limited to) one-on-one communications, public posts/comments,
+code reviews, pull requests, and GitHub issues. If violations occur, Test Double
+will take any action they deem appropriate for the infraction, up to and
+including blocking a user from the organization's repositories.
 

data/exe/cypress-rails

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-ENV["RAILS_ENV"] = "test"
+ENV["RAILS_ENV"] ||= "test"
 require "pathname"
 require "cypress-rails"
 require Pathname.new(CypressRails::Config.new.dir).join("config/environment")

data/lib/cypress-rails/config.rb

@@ -1,14 +1,23 @@
 require_relative "env"
 
 module CypressRails
-  class Config < Struct.new(:dir, :port, :transactional_server, :cypress_cli_opts, keyword_init: true)
+  class Config
+    attr_accessor :dir, :host, :port, :base_path, :transactional_server, :cypress_cli_opts
+
     def initialize(
       dir: Env.fetch("CYPRESS_RAILS_DIR", default: Dir.pwd),
+      host: Env.fetch("CYPRESS_RAILS_HOST", default: "127.0.0.1"),
       port: Env.fetch("CYPRESS_RAILS_PORT"),
+      base_path: Env.fetch("CYPRESS_RAILS_BASE_PATH", default: "/"),
       transactional_server: Env.fetch("CYPRESS_RAILS_TRANSACTIONAL_SERVER", type: :boolean, default: true),
       cypress_cli_opts: Env.fetch("CYPRESS_RAILS_CYPRESS_OPTS", default: "")
     )
-      super
+      @dir = dir
+      @host = host
+      @port = port
+      @base_path = base_path
+      @transactional_server = transactional_server
+      @cypress_cli_opts = cypress_cli_opts
     end
 
     def to_s
@@ -17,7 +26,9 @@ module CypressRails
         cypress-rails configuration:
         ============================
          CYPRESS_RAILS_DIR.....................#{dir.inspect}
+         CYPRESS_RAILS_HOST....................#{host.inspect}
          CYPRESS_RAILS_PORT....................#{port.inspect}
+         CYPRESS_RAILS_BASE_PATH...............#{base_path.inspect}
          CYPRESS_RAILS_TRANSACTIONAL_SERVER....#{transactional_server.inspect}
          CYPRESS_RAILS_CYPRESS_OPTS............#{cypress_cli_opts.inspect}
 

data/lib/cypress-rails/launches_cypress.rb

@@ -20,6 +20,7 @@ module CypressRails
         @manages_transactions.begin_transaction
       end
       server = @starts_rails_server.call(
+        host: config.host,
         port: config.port,
         transactional_server: config.transactional_server
       )
@@ -27,9 +28,12 @@ module CypressRails
 
       set_exit_hooks!(config)
 
-      system <<~EXEC
-        CYPRESS_BASE_URL=http://#{server.host}:#{server.port} "#{bin}" #{command} --project "#{config.dir}" #{config.cypress_cli_opts}
+      command = <<~EXEC
+        CYPRESS_BASE_URL="http://#{server.host}:#{server.port}#{config.base_path}" "#{bin}" #{command} --project "#{config.dir}" #{config.cypress_cli_opts}
       EXEC
+
+      puts "\nLaunching Cypress…\n$ #{command}\n"
+      system command
     end
 
     private

data/lib/cypress-rails/manages_transactions.rb

@@ -68,19 +68,7 @@ module CypressRails
     # need to share a connection pool so that the reading connection
     # can see data in the open transaction on the writing connection.
     def setup_shared_connection_pool
-      return unless ActiveRecord::Base.respond_to?(:connection_handlers)
-
-      writing_handler = ActiveRecord::Base.connection_handler
-      ActiveRecord::Base.connection_handlers.values.each do |handler|
-        if handler != writing_handler
-          handler.connection_pool_list.each do |pool|
-            name = pool.spec.name
-            writing_connection = writing_handler.retrieve_connection_pool(name)
-            return nil unless writing_connection
-            handler.send(:owner_to_pool)[name] = writing_connection
-          end
-        end
-      end
+      ActiveRecord::TestFixtures.instance_method(:setup_shared_connection_pool).bind(self).call
     end
   end
 end

data/lib/cypress-rails/server.rb

@@ -16,11 +16,11 @@ module CypressRails
       end
     end
 
-    attr_reader :app, :port, :host
+    attr_reader :app, :host, :port
 
     def initialize(app,
+      host:,
       port:,
-      host: "127.0.0.1",
       reportable_errors: [Exception],
       extra_middleware: [])
       @app = app
@@ -84,10 +84,6 @@ module CypressRails
       self
     end
 
-    def base_url
-      "http#{"s" if using_ssl?}://#{host}:#{port}"
-    end
-
     private
 
     def middleware

data/lib/cypress-rails/starts_rails_server.rb

@@ -3,10 +3,10 @@ require_relative "server"
 
 module CypressRails
   class StartsRailsServer
-    def call(port:, transactional_server:)
+    def call(host:, port:, transactional_server:)
       configure_rails_to_run_our_state_reset_on_every_request!(transactional_server)
       app = create_rack_app
-      Server.new(app, port: port).tap do |server|
+      Server.new(app, host: host, port: port).tap do |server|
         server.boot
       end
     end

data/lib/cypress-rails/version.rb

@@ -1,3 +1,3 @@
 module CypressRails
-  VERSION = "0.1.5"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cypress-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.4.2
 platform: ruby
 authors:
 - Justin Searls
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
-description: 
+description:
 email:
 - searls@gmail.com
 executables:
@@ -142,7 +142,7 @@ homepage: https://github.com/testdouble/cypress-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Helps you write Cypress tests of your Rails app
 test_files: []