cypress-on-rails 1.10.1 → 1.15.1

data/docs/authentication.md

@@ -1,6 +1,6 @@
 # Example for Authenticating a User
 
-in routes.rb
+In `config/routes.rb`:
 ```rb
 Rails.application.routes.draw do
   # ...... your other routes
@@ -12,7 +12,7 @@ Rails.application.routes.draw do
 end
 ```
 
-app/controllers/cypress_controller.rb
+`app/controllers/cypress_controller.rb`:
 ```rb
 class CypressController < ApplicationController
   skip_before_action :verify_authenticity_token
@@ -29,21 +29,23 @@ class CypressController < ApplicationController
 end
 ```
 
-in cypress/support/on-rails.js
+In `cypress/support/on-rails.js`:
 ```js
-Cypress.Commands.add("forceLogin", (details) => {
-  if(!details)
+Cypress.Commands.add('forceLogin', (details) => {
+  if (!details) {
     details = {}
+  }
 
-  if(!details.redirect_to)
+  if (!details.redirect_to) {
     details.redirect_to = '/'
+  }
 
-  cy.visit("__cypress__/forceLogin",
-    { method: "POST", body: { email: details.email, redirect_to: details.redirect_to }  })
-});
+  cy.visit('__cypress__/forceLogin',
+    { method: 'POST', body: { email: details.email, redirect_to: details.redirect_to } })
+})
 ```
 
-examples of usage in cypress specs
+Examples of usage in Cypress specs:
 ```js
 cy.forceLogin()
 cy.forceLogin({redirect_to: '/profile'})

data/docs/factory_bot_associations.md

@@ -0,0 +1,109 @@
+# Setting up associations with the correct data
+
+You cannot access associations directly from Cypress like you can do with Ruby tests.
+So setting up associations has to be done differently from within Cypress.
+
+There are a few ways you can setup associations with the correct data using Cypress and FactoryBot.
+1. Setting the foreign keys
+2. Using transient attributes
+3. Using Nested Attributes
+4. Combination of the above depending on your situation
+
+Assuming you have the following models
+
+```rb
+class Post < ApplicationRecord
+  belongs_to :author
+  accepts_nested_attributes_for :author
+end
+
+class Author < ApplicationRecord
+  has_many :posts
+  accepts_nested_attributes_for :posts
+end
+```
+
+You can do the following:
+
+## 1. Setting the foreign keys
+
+`factories.rb`:
+```rb
+FactoryBot.define do
+  factory :author do
+    name { 'Taylor' }
+  end
+
+  factory :post do
+    title { 'Cypress on Rails is Awesome' }
+    author_id { create(:author).id }
+  end
+end
+```
+
+then in Cypress
+```js
+// example with overriding the defaults
+cy.appFactories([['create', 'author', { name: 'James' }]]).then((records) => {
+  cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_id: records[0].id }]])
+})
+
+// example without overriding anything
+cy.appFactories([['create', 'author']]).then((records) => {
+  cy.appFactories([['create', 'post', { author_id: records[0].id }]])
+})
+```
+
+## 2. Using transient attributes
+
+```rb
+FactoryBot.define do
+  factory :author do
+    name { 'Taylor' }
+  end
+
+  factory :post do
+    transient do
+      author_name { 'Taylor' }
+    end
+    title { 'Cypress on Rails is Awesome' }
+    author { create(:author, name: author_name ) }
+  end
+end
+```
+
+then in Cypress
+```js
+// example with overriding the defaults
+cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_name: 'James' }]])
+
+// example without overriding
+cy.appFactories([['create', 'post']])
+```
+
+## 3. Using Nested Attributes
+
+```rb
+FactoryBot.define do
+  factory :author do
+    name { 'Taylor' }
+  end
+
+  factory :post do
+    title { 'Cypress on Rails is Awesome' }
+    author_attributes { { name: 'Taylor' } }
+  end
+end
+```
+
+then in Cypress
+```js
+// example with overriding the defaults
+cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_attributes: { name: 'James' } }]])
+
+// example without overriding
+cy.appFactories([['create', 'post']])
+
+// example of creating author with multiple posts
+cy.appFactories([['create', 'author', { name: 'James', posts_attributes: [{ name: 'Cypress is cool' }, {name: 'Rails is awesome' }] }]])
+```

data/lib/cypress-on-rails.rb

@@ -3,5 +3,5 @@ require 'cypress_on_rails/configuration'
 require_relative './cypress_on_rails/railtie' if defined?(Rails)
 
 # maintain backward compatibility
-CypressDev = CypressOnRails
-Cypress = CypressDev
+CypressDev = CypressOnRails unless defined?(CypressDev)
+Cypress = CypressDev unless defined?(Cypress)

data/lib/cypress_on_rails/command_executor.rb

@@ -4,7 +4,7 @@ module CypressOnRails
   # loads and evals the command files
   class CommandExecutor
     def self.perform(file,command_options = nil)
-      load_cypress_helper
+      load_e2e_helper
       file_data = File.read(file)
       eval file_data, binding, file
     rescue => e
@@ -13,12 +13,16 @@ module CypressOnRails
       raise e
     end
 
-    def self.load_cypress_helper
-      cypress_helper_file = "#{configuration.cypress_folder}/cypress_helper"
-      if File.exist?("#{cypress_helper_file}.rb")
+    def self.load_e2e_helper
+      e2e_helper_file = "#{configuration.install_folder}/e2e_helper.rb"
+      cypress_helper_file = "#{configuration.install_folder}/cypress_helper.rb"
+      if File.exist?(e2e_helper_file)
+        Kernel.require e2e_helper_file
+      elsif File.exist?(cypress_helper_file)
         Kernel.require cypress_helper_file
+        warn "cypress_helper.rb is deprecated, please rename the file to e2e_helper.rb"
       else
-        logger.warn "could not find #{cypress_helper_file}.rb"
+        logger.warn "could not find #{e2e_helper_file} nor #{cypress_helper_file}"
       end
     end
 

data/lib/cypress_on_rails/configuration.rb

@@ -2,19 +2,34 @@ require 'logger'
 
 module CypressOnRails
   class Configuration
-    attr_accessor :cypress_folder
+    attr_accessor :api_prefix
+    attr_accessor :install_folder
     attr_accessor :use_middleware
+    attr_accessor :use_vcr_middleware
     attr_accessor :logger
 
+    # Attributes for backwards compatibility
+    def cypress_folder
+      warn "cypress_folder is deprecated, please use install_folder"
+      install_folder
+    end
+    def cypress_folder=(v)
+      warn "cypress_folder= is deprecated, please use install_folder"
+      self.install_folder = v
+    end
+
     def initialize
       reset
     end
 
     alias :use_middleware? :use_middleware
+    alias :use_vcr_middleware? :use_vcr_middleware
 
     def reset
-      self.cypress_folder = 'spec/cypress'
+      self.api_prefix = ''
+      self.install_folder = 'spec/e2e'
       self.use_middleware = true
+      self.use_vcr_middleware = false
       self.logger = Logger.new(STDOUT)
     end
 

data/lib/cypress_on_rails/middleware.rb

@@ -1,11 +1,13 @@
 require 'json'
 require 'rack'
-require 'cypress_on_rails/configuration'
+require 'cypress_on_rails/middleware_config'
 require 'cypress_on_rails/command_executor'
 
 module CypressOnRails
-  # Middleware to handle cypress commands and eval
+  # Middleware to handle testing framework commands and eval
   class Middleware
+    include MiddlewareConfig
+
     def initialize(app, command_executor = CommandExecutor, file = ::File)
       @app = app
       @command_executor = command_executor
@@ -14,7 +16,10 @@ module CypressOnRails
 
     def call(env)
       request = Rack::Request.new(env)
-      if request.path.start_with?('/__cypress__/command')
+      if request.path.start_with?("#{configuration.api_prefix}/__e2e__/command")
+        configuration.tagged_logged { handle_command(request) }
+      elsif request.path.start_with?("#{configuration.api_prefix}/__cypress__/command")
+        warn "/__cypress__/command is deprecated. Please use the install generator to use /__e2e__/command instead."
         configuration.tagged_logged { handle_command(request) }
       else
         @app.call(env)
@@ -23,15 +28,7 @@ module CypressOnRails
 
     private
 
-    def configuration
-      CypressOnRails.configuration
-    end
-
-    def logger
-      configuration.logger
-    end
-
-    Command = Struct.new(:name, :options, :cypress_folder) do
+    Command = Struct.new(:name, :options, :install_folder) do
       # @return [Array<Cypress::Middleware::Command>]
       def self.from_body(body, configuration)
         if body.is_a?(Array)
@@ -40,12 +37,12 @@ module CypressOnRails
           command_params = [body]
         end
         command_params.map do |params|
-          new(params.fetch('name'), params['options'], configuration.cypress_folder)
+          new(params.fetch('name'), params['options'], configuration.install_folder)
         end
       end
 
       def file_path
-        "#{cypress_folder}/app_commands/#{name}.rb"
+        "#{install_folder}/app_commands/#{name}.rb"
       end
     end
 
@@ -53,7 +50,7 @@ module CypressOnRails
       body = JSON.parse(req.body.read)
       logger.info "handle_command: #{body}"
       commands = Command.from_body(body, configuration)
-      missing_command = commands.find {|command| !@file.exists?(command.file_path) }
+      missing_command = commands.find {|command| !@file.exist?(command.file_path) }
 
       if missing_command.nil?
         begin
@@ -65,13 +62,15 @@ module CypressOnRails
             output = {"message" => "Cannot convert to json"}.to_json
           end
 
+          logger.debug "output: #{output}"
           [201, {'Content-Type' => 'application/json'}, [output]]
         rescue => e
           output = {"message" => e.message, "class" => e.class.to_s}.to_json
           [500, {'Content-Type' => 'application/json'}, [output]]
         end
       else
-        [404, {}, ["could not find command file: #{missing_command.file_path}"]]
+        output = {"message" => "could not find command file: #{missing_command.file_path}"}.to_json
+        [404, {'Content-Type' => 'application/json'}, [output]]
       end
     end
   end

data/lib/cypress_on_rails/middleware_config.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'rack'
+require 'cypress_on_rails/configuration'
+
+module CypressOnRails
+  module MiddlewareConfig
+    protected
+
+    def configuration
+      CypressOnRails.configuration
+    end
+
+    def logger
+      configuration.logger
+    end
+  end
+end

data/lib/cypress_on_rails/railtie.rb

@@ -1,13 +1,17 @@
 require 'rails/railtie'
 require 'cypress_on_rails/configuration'
-require 'cypress_on_rails/middleware'
 
 module CypressOnRails
   class Railtie < Rails::Railtie
     initializer :setup_cypress_middleware, after: :load_config_initializers do |app|
       if CypressOnRails.configuration.use_middleware?
+        require 'cypress_on_rails/middleware'
         app.middleware.use Middleware
       end
+      if CypressOnRails.configuration.use_vcr_middleware?
+        require 'cypress_on_rails/vcr_middleware'
+        app.middleware.use VCRMiddleware
+      end
     end
   end
 end

data/lib/cypress_on_rails/smart_factory_wrapper.rb

@@ -19,6 +19,18 @@ module CypressOnRails
       instance.create_list(*args)
     end
 
+    def self.build(*args)
+      instance.build(*args)
+    end
+
+    def self.build_list(*args)
+      instance.build_list(*args)
+    end
+
+    def self.reload
+      instance.reload
+    end
+
     # @return [Array]
     attr_accessor :factory
     attr_accessor :always_reload
@@ -36,7 +48,7 @@ module CypressOnRails
     end
 
     def create(*options)
-      load_files
+      auto_reload
       factory_name = options.shift
       if options.last.is_a?(Hash)
         args = options.pop
@@ -47,10 +59,36 @@ module CypressOnRails
     end
 
     def create_list(*args)
-      load_files
+      auto_reload
       factory.create_list(*args)
     end
 
+    def build(*options)
+      auto_reload
+      factory_name = options.shift
+      if options.last.is_a?(Hash)
+        args = options.pop
+      else
+        args = {}
+      end
+      factory.build(factory_name, *options.map(&:to_sym), args.symbolize_keys)
+    end
+
+    def build_list(*args)
+      auto_reload
+      factory.build_list(*args)
+    end
+
+    def reload
+      @latest_mtime = current_latest_mtime
+      logger.info 'Loading Factories'
+      factory.reload
+      files.each do |file|
+        logger.debug "-- Loading: #{file}"
+        @kernel.load(file)
+      end 
+    end
+
     private
 
     # @param [String,Array] arg
@@ -68,20 +106,17 @@ module CypressOnRails
       CypressOnRails.configuration.logger
     end
 
-    def load_files
-      current_latest_mtime = files.map{|file| @file_system.mtime(file) }.max
-      return unless should_reload?(current_latest_mtime)
-      logger.info 'Loading Factories'
-      @latest_mtime = current_latest_mtime
-      factory.reload
-      files.each do |file|
-        logger.debug "-- Loading: #{file}"
-        @kernel.load(file)
-      end
+    def current_latest_mtime
+      files.map{|file| @file_system.mtime(file) }.max
+    end
+
+    def auto_reload
+      return unless should_reload?
+      reload
     end
 
-    def should_reload?(current_latest_mtime)
+    def should_reload?
       @always_reload || @latest_mtime.nil? || @latest_mtime < current_latest_mtime
     end
   end
-end
+end

data/lib/cypress_on_rails/vcr_middleware.rb

@@ -0,0 +1,73 @@
+require 'json'
+require 'rack'
+require 'cypress_on_rails/middleware_config'
+
+module CypressOnRails
+  # Middleware to handle vcr
+  class VCRMiddleware
+    include MiddlewareConfig
+
+    def initialize(app, vcr = nil)
+      @app = app
+      @vcr = vcr
+      @first_call = false
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.path.start_with?('/__e2e__/vcr/insert')
+        configuration.tagged_logged { handle_insert(request) }
+      elsif request.path.start_with?('/__e2e__/vcr/eject')
+        configuration.tagged_logged { handle_eject }
+      else
+        do_first_call unless @first_call
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def handle_insert(req)
+      WebMock.enable! if defined?(WebMock)
+      vcr.turn_on!
+      body = JSON.parse(req.body.read)
+      logger.info "vcr insert cassette: #{body}"
+      cassette_name = body[0]
+      options = (body[1] || {}).symbolize_keys
+      options[:record] = options[:record].to_sym if options[:record]
+      options[:match_requests_on] = options[:match_requests_on].map(&:to_sym) if options[:match_requests_on]
+      options[:serialize_with] = options[:serialize_with].to_sym if options[:serialize_with]
+      options[:persist_with] = options[:persist_with].to_sym if options[:persist_with]
+      vcr.insert_cassette(cassette_name, options)
+      [201, {'Content-Type' => 'application/json'}, [{'message': 'OK'}.to_json]]
+    rescue LoadError, ArgumentError => e
+      [501, {'Content-Type' => 'application/json'}, [{'message': e.message}.to_json]]
+    end
+
+    def handle_eject
+      logger.info "vcr eject cassette"
+      vcr.eject_cassette
+      do_first_call
+      [201, {'Content-Type' => 'application/json'}, [{'message': 'OK'}.to_json]]
+    rescue LoadError, ArgumentError => e
+      [501, {'Content-Type' => 'application/json'}, [{'message': e.message}.to_json]]
+    end
+
+    def vcr
+      return @vcr if @vcr
+      require 'vcr'
+      VCR.configure do |config|
+        config.cassette_library_dir = "#{configuration.install_folder}/fixtures/vcr_cassettes"
+      end
+      @vcr = VCR
+    end
+
+    def do_first_call
+      @first_call = true
+      vcr.turn_off!
+      WebMock.disable! if defined?(WebMock)
+    rescue LoadError
+      # nop
+    end
+  end
+end

data/lib/cypress_on_rails/version.rb

@@ -1,3 +1,3 @@
 module CypressOnRails
-  VERSION = '1.10.1'.freeze
+  VERSION = '1.15.1'.freeze
 end

data/lib/generators/cypress_on_rails/install_generator.rb

@@ -1,50 +1,68 @@
 module CypressOnRails
   class InstallGenerator < Rails::Generators::Base
-    class_option :cypress_folder, type: :string, default: 'cypress'
+    class_option :api_prefix, type: :string, default: ''
+    class_option :install_folder, type: :string, default: 'e2e'
     class_option :install_cypress, type: :boolean, default: true
-    class_option :install_cypress_with, type: :string, default: 'yarn'
-    class_option :install_cypress_examples, type: :boolean, default: false
+    class_option :install_playwright, type: :boolean, default: false
+    class_option :install_with, type: :string, default: 'yarn'
+    class_option :cypress_folder, type: :string, default: 'cypress'
+    class_option :playwright_folder, type: :string, default: 'playwright'
+    class_option :experimental, type: :boolean, default: false
     source_root File.expand_path('../templates', __FILE__)
 
-    def install_cypress
-      if !Dir.exists?(options.cypress_folder) || Dir["#{options.cypress_folder}/*"].empty?
-        directories = options.cypress_folder.split('/')
-        directories.pop
-        install_dir = "#{Dir.pwd}/#{directories.join('/')}"
-        command = nil
-        if options.install_cypress
-          if options.install_cypress_with == 'yarn'
-            command = "yarn --cwd=#{install_dir} add cypress --dev"
-          elsif options.install_cypress_with == 'npm'
-            command = "cd #{install_dir}; npm install cypress --save-dev"
-          end
-          if command
-            say command
-            fail 'failed to install cypress' unless system(command)
-          end
-        end
-        if options.install_cypress_examples
-          directory 'spec/cypress/integration/examples', "#{options.cypress_folder}/integration/examples"
-          directory 'spec/cypress/fixtures', "#{options.cypress_folder}/fixtures"
-        end
-        copy_file "spec/cypress/support/index.js", "#{options.cypress_folder}/support/index.js"
+    def install_framework
+      directories = options.install_folder.split('/')
+      directories.pop
+      install_dir = "#{Dir.pwd}/#{directories.join('/')}"
+
+      command = nil
+      packages = []
+
+      packages << 'cypress' if options.install_cypress
+      packages.push('playwright', '@playwright/test') if options.install_playwright
+
+      if options.install_with == 'yarn'
+        command = "yarn --cwd=#{install_dir} add #{packages.join(' ')} --dev"
+      elsif options.install_with == 'npm'
+        command = "cd #{install_dir}; npm install #{packages.join(' ')} --save-dev"
+      end
+      if command
+        say command
+        fail "failed to install #{packages.join(' ')}" unless system(command)
+      end
+
+      if options.install_cypress
+        template "spec/cypress/support/index.js.erb", "#{options.cypress_folder}/support/index.js"
         copy_file "spec/cypress/support/commands.js", "#{options.cypress_folder}/support/commands.js"
-        copy_file "spec/cypress.json", "#{options.cypress_folder}/../cypress.json"
+        copy_file "spec/cypress.config.js", "#{options.cypress_folder}/../cypress.config.js"
+      end
+      if options.install_playwright
+        template "spec/playwright/support/index.js.erb", "#{options.playwright_folder}/support/index.js"
+        copy_file "spec/playwright.config.js", "#{options.playwright_folder}/../playwright.config.js"
       end
     end
 
     def add_initial_files
       template "config/initializers/cypress_on_rails.rb.erb", "config/initializers/cypress_on_rails.rb"
-      copy_file "spec/cypress/cypress_helper.rb", "#{options.cypress_folder}/cypress_helper.rb"
-      copy_file "spec/cypress/support/on-rails.js", "#{options.cypress_folder}/support/on-rails.js"
-      directory 'spec/cypress/app_commands', "#{options.cypress_folder}/app_commands"
-      directory 'spec/cypress/integration/rails_examples', "#{options.cypress_folder}/integration/rails_examples"
+      template "spec/e2e/e2e_helper.rb.erb", "#{options.install_folder}/e2e_helper.rb"
+      directory 'spec/e2e/app_commands', "#{options.install_folder}/app_commands"
+      if options.install_cypress
+        copy_file "spec/cypress/support/on-rails.js", "#{options.cypress_folder}/support/on-rails.js"
+        directory 'spec/cypress/e2e/rails_examples', "#{options.cypress_folder}/e2e/rails_examples"
+      end
+      if options.install_playwright
+        copy_file "spec/playwright/support/on-rails.js", "#{options.playwright_folder}/support/on-rails.js"
+        directory 'spec/playwright/e2e/rails_examples', "#{options.playwright_folder}/e2e/rails_examples"
+      end
     end
 
     def update_files
       append_to_file "#{options.cypress_folder}/support/index.js",
                      "\nimport './on-rails'",
                      after: 'import \'./commands\''
+      append_to_file "#{options.playwright_folder}/support/index.js",
+                     "\nimport './on-rails'",
+                     after: '// Import commands.js using ES2015 syntax:'
     end
   end
 end

data/lib/generators/cypress_on_rails/templates/config/initializers/cypress_on_rails.rb.erb

@@ -1,9 +1,11 @@
 if defined?(CypressOnRails)
   CypressOnRails.configure do |c|
-    c.cypress_folder = File.expand_path("#{__dir__}/../../<%= options.cypress_folder %>")
+    c.api_prefix = "<%= options.api_prefix %>"
+    c.install_folder = File.expand_path("#{__dir__}/../../<%= options.install_folder %>")
     # WARNING!! CypressOnRails can execute arbitrary ruby code
     # please use with extra caution if enabling on hosted servers or starting your local server on 0.0.0.0
     c.use_middleware = !Rails.env.production?
+    <% unless options.experimental %># <% end %> c.use_vcr_middleware = !Rails.env.production?
     c.logger = Rails.logger
   end
 

data/lib/generators/cypress_on_rails/templates/spec/cypress/{integration/rails_examples/advance_factory_bot_spec.js → e2e/rails_examples/advance_factory_bot.cy.js}

@@ -1,6 +1,6 @@
 describe('More Rails using factory bot examples', function() {
   beforeEach(() => {
-    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+    cy.app('clean') // have a look at e2e/app_commands/clean.rb
   })
 
   it('using response from factory bot', function() {

data/lib/generators/cypress_on_rails/templates/spec/cypress/{integration/rails_examples/other_spec.js → e2e/rails_examples/other.cy.js}

@@ -1,6 +1,6 @@
 describe('Rails Other examples', function() {
   it('cypress eval', function() {
-    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+    cy.app('clean') // have a look at e2e/app_commands/clean.rb
     cy.appEval("Post.create(title: 'Hello Eval')")
 
     cy.visit('/')

data/lib/generators/cypress_on_rails/templates/spec/cypress/{integration/rails_examples/using_factory_bot_spec.js → e2e/rails_examples/using_factory_bot.cy.js}

@@ -1,6 +1,6 @@
 describe('Rails using factory bot examples', function() {
   beforeEach(() => {
-    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+    cy.app('clean') // have a look at e2e/app_commands/clean.rb
   })
 
   it('using single factory bot', function() {