cypress-rails 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af0f5454fad2f6123912ffa40ce321337d72b38a46f416137bff14175ca54afc
-  data.tar.gz: 203880ed6ddba42e5e509ceda78561c1bde41b4df2edb5555f74a66f934a8351
+  metadata.gz: 562fe8191d39ef805cb9f6ff8cc82f7c1329acc61332425bd23a6c6ff1ccccd2
+  data.tar.gz: 267ac2d8ef9c9969205798acbe5239d398eb35ba93a2a45bedaa18fba8056a60
 SHA512:
-  metadata.gz: 4ccc3764f1169131326d8b8d4a1a614526343dc3b9ba4d102ab009fdad3199f00b73a5fab05b282e346bd18a11f2564f257f355dd8a884b32147f80b5faa09ec
-  data.tar.gz: 66023c5a4478c9a2ff6a8affd906808cc1a58322c9a09fc3c46031ace2dc26bc97eec3c1a2e4b30d727ce7d88814408c5e4609e8c5d08cb2de16167e0650a6d4
+  metadata.gz: 9b8b12ab6e9f8f565afd72dfc345d717fb8b957ebe6ca4e73f883d9a2f4278eef4ae89335b85e305065114bedbe797e4ba2fb5cdb5b4457ccd93ea9b245f7a51
+  data.tar.gz: 90945b95efc3e0d58651af35d1a13a7740eea905103aa4b8263af380c789f6f0c8a605f58542d8077e26639136ca9f5f0e44ca915b216c8decabd4f2c8e20999

data/.circleci/config.yml

@@ -34,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
@@ -46,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,41 @@
 # CHANGELOG
 
+## 0.5.0
+
+* Add hook `before_server_start`
+  [#63](https://github.com/testdouble/cypress-rails/pull/63)
+* Fix namespace bug
+  [#64](https://github.com/testdouble/cypress-rails/pull/64)
+
+## 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,56 @@
 PATH
   remote: .
   specs:
-    cypress-rails (0.2.0)
+    cypress-rails (0.5.0)
       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.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      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.3.1)
+      activesupport (= 6.1.3.1)
       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.3.1)
       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.8)
     crass (1.0.6)
-    erubi (1.9.0)
-    i18n (1.8.2)
+    erubi (1.10.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    loofah (2.5.0)
+    loofah (2.9.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)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.0.4)
-      ast (~> 2.4.0)
-    puma (4.3.3)
+    mini_portile2 (2.5.0)
+    minitest (5.14.2)
+    nio4r (2.5.7)
+    nokogiri (1.11.2)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    puma (5.2.2)
       nio4r (~> 2.0)
-    rack (2.2.2)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -57,33 +58,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.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       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)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.3.0)
+    standard (0.10.2)
+      rubocop (= 1.4.2)
+      rubocop-performance (= 1.9.1)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -96,4 +103,4 @@ DEPENDENCIES
   standard (>= 0.2.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -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,14 +158,36 @@ 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
   be rolled back on exit (similar to running a Rails System test)
 * **CYPRESS_RAILS_CYPRESS_OPTS** (default: _none_) any options you want to
-  forward to the Cypress CLI when running its `open` or `run` commands
+  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
+```
+
+#### Example: Running your tests in Chromium
+
+By default, Cypress will run its tests in its packaged Electron app, unless you've configured it globally. To choose which browser it will run from the command line, try this:
+
+```
+$ CYPRESS_RAILS_CYPRESS_OPTS="--browser chromium" bin/rake cypress:run
+```
 
 ### Initializer hooks
 
@@ -176,6 +198,11 @@ will execute before the server or any transaction has been started. If you use
 Rails fixtures, it may make sense to load them here, so they don't need to be
 re-inserted for each request
 
+### after_server_start
+
+Pass a block to `CypressRails.hooks.after_server_start` to register a hook that
+will execute after the server has booted.
+
 ### after_transaction_start
 
 If there's any custom behavior or state management you want to do inside the
@@ -198,6 +225,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
@@ -274,7 +317,7 @@ experience. In particular:
   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
+  Capybara API method, failures tend 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
 * With very few exceptions, a Cypress test that works in a browser window will
@@ -305,5 +348,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/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/initializer_hooks.rb

@@ -12,6 +12,10 @@ module CypressRails
       register(:before_server_start, blk)
     end
 
+    def after_server_start(&blk)
+      register(:after_server_start, blk)
+    end
+
     def after_transaction_start(&blk)
       register(:after_transaction_start, blk)
     end

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

@@ -20,7 +20,7 @@ module CypressRails
 
           begin
             connection = ActiveRecord::Base.connection_handler.retrieve_connection(spec_name)
-          rescue ConnectionNotEstablished
+          rescue ActiveRecord::ConnectionNotEstablished
             connection = nil
           end
 
@@ -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

@@ -3,6 +3,7 @@
 require "uri"
 require "net/http"
 require "rack"
+require_relative "initializer_hooks"
 require_relative "server/middleware"
 require_relative "server/checker"
 require_relative "server/timer"
@@ -16,11 +17,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
@@ -32,6 +33,7 @@ module CypressRails
       @port ||= Server.ports[port_key]
       @port ||= find_available_port(host)
       @checker = Checker.new(@host, @port)
+      @initializer_hooks = InitializerHooks.instance
     end
 
     def reset_error!
@@ -78,16 +80,13 @@ module CypressRails
           raise "Rack application timed out during boot" if timer.expired?
 
           @server_thread.join(0.1)
+          @initializer_hooks.run(:after_server_start)
         end
       end
 
       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.2.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cypress-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Searls
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2021-03-31 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
@@ -157,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Helps you write Cypress tests of your Rails app
 test_files: []