cypress-on-rails 1.18.0 → 1.20.0

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+require 'rails/generators'
+require 'generators/cypress_on_rails/install_generator'
+require 'tmpdir'
+require 'fileutils'
+
+RSpec.describe CypressOnRails::InstallGenerator, type: :generator do
+  let(:destination_root) { Dir.mktmpdir }
+
+  before do
+    # Set up a minimal Rails app structure
+    FileUtils.mkdir_p(File.join(destination_root, 'config', 'initializers'))
+    FileUtils.mkdir_p(File.join(destination_root, 'bin'))
+
+    # Mock the generator's destination_root
+    allow(Dir).to receive(:pwd).and_return(destination_root)
+
+    # Prevent actual npm/yarn installation in tests
+    # Mock only package manager commands, let file operations through
+    allow_any_instance_of(CypressOnRails::InstallGenerator).to receive(:system) do |_, command|
+      # Return true for yarn/npm install commands to skip actual installation
+      command.to_s.match?(/yarn|npm/)
+    end
+  end
+
+  after do
+    FileUtils.rm_rf(destination_root)
+  end
+
+  describe 'with default options (cypress framework, e2e folder)' do
+    let(:args) { [] }
+    let(:options) { {} }
+
+    before do
+      run_generator(args, options)
+    end
+
+    it 'creates the initializer with correct install_folder path' do
+      initializer_path = File.join(destination_root, 'config', 'initializers', 'cypress_on_rails.rb')
+      expect(File).to exist(initializer_path)
+
+      content = File.read(initializer_path)
+      # Should point to e2e, not e2e/cypress
+      expect(content).to include('c.install_folder = File.expand_path("#{__dir__}/../../e2e")')
+    end
+
+    it 'creates cypress config at install_folder root' do
+      config_path = File.join(destination_root, 'e2e', 'cypress.config.js')
+      expect(File).to exist(config_path)
+    end
+
+    it 'creates e2e_helper.rb at install_folder root' do
+      helper_path = File.join(destination_root, 'e2e', 'e2e_helper.rb')
+      expect(File).to exist(helper_path)
+    end
+
+    it 'creates app_commands directory at install_folder root' do
+      commands_path = File.join(destination_root, 'e2e', 'app_commands')
+      expect(File).to be_directory(commands_path)
+    end
+
+    it 'creates cypress support files in framework subdirectory' do
+      support_path = File.join(destination_root, 'e2e', 'cypress', 'support', 'index.js')
+      expect(File).to exist(support_path)
+    end
+
+    it 'creates cypress examples in framework subdirectory' do
+      examples_path = File.join(destination_root, 'e2e', 'cypress', 'e2e', 'rails_examples')
+      expect(File).to be_directory(examples_path)
+    end
+  end
+
+  describe 'with playwright framework' do
+    let(:args) { [] }
+    let(:options) { { framework: 'playwright' } }
+
+    before do
+      run_generator(args, options)
+    end
+
+    it 'creates the initializer with correct install_folder path' do
+      initializer_path = File.join(destination_root, 'config', 'initializers', 'cypress_on_rails.rb')
+      expect(File).to exist(initializer_path)
+
+      content = File.read(initializer_path)
+      # Should point to e2e, not e2e/playwright
+      expect(content).to include('c.install_folder = File.expand_path("#{__dir__}/../../e2e")')
+    end
+
+    it 'creates playwright config at install_folder root' do
+      config_path = File.join(destination_root, 'e2e', 'playwright.config.js')
+      expect(File).to exist(config_path)
+    end
+
+    it 'creates e2e_helper.rb at install_folder root' do
+      helper_path = File.join(destination_root, 'e2e', 'e2e_helper.rb')
+      expect(File).to exist(helper_path)
+    end
+
+    it 'creates app_commands directory at install_folder root' do
+      commands_path = File.join(destination_root, 'e2e', 'app_commands')
+      expect(File).to be_directory(commands_path)
+    end
+
+    it 'creates playwright support files in framework subdirectory' do
+      support_path = File.join(destination_root, 'e2e', 'playwright', 'support', 'index.js')
+      expect(File).to exist(support_path)
+    end
+
+    it 'creates playwright examples in framework subdirectory' do
+      examples_path = File.join(destination_root, 'e2e', 'playwright', 'e2e', 'rails_examples')
+      expect(File).to be_directory(examples_path)
+    end
+  end
+
+  describe 'with custom install_folder' do
+    let(:args) { [] }
+    let(:options) { { install_folder: 'spec/system' } }
+
+    before do
+      run_generator(args, options)
+    end
+
+    it 'creates files in the custom folder' do
+      helper_path = File.join(destination_root, 'spec', 'system', 'e2e_helper.rb')
+      expect(File).to exist(helper_path)
+
+      commands_path = File.join(destination_root, 'spec', 'system', 'app_commands')
+      expect(File).to be_directory(commands_path)
+    end
+
+    it 'sets the correct install_folder in the initializer' do
+      initializer_path = File.join(destination_root, 'config', 'initializers', 'cypress_on_rails.rb')
+      content = File.read(initializer_path)
+      expect(content).to include('c.install_folder = File.expand_path("#{__dir__}/../../spec/system")')
+    end
+  end
+
+  describe 'file structure ensures middleware and framework compatibility' do
+    let(:args) { [] }
+    let(:options) { {} }
+
+    before do
+      run_generator(args, options)
+    end
+
+    it 'does not create e2e_helper.rb in old location (framework subdirectory)' do
+      old_cypress_path = File.join(destination_root, 'e2e', 'cypress', 'e2e_helper.rb')
+      old_playwright_path = File.join(destination_root, 'e2e', 'playwright', 'e2e_helper.rb')
+      expect(File).not_to exist(old_cypress_path)
+      expect(File).not_to exist(old_playwright_path)
+    end
+
+    it 'does not create app_commands in old location (framework subdirectory)' do
+      old_cypress_path = File.join(destination_root, 'e2e', 'cypress', 'app_commands')
+      old_playwright_path = File.join(destination_root, 'e2e', 'playwright', 'app_commands')
+      expect(File).not_to exist(old_cypress_path)
+      expect(File).not_to exist(old_playwright_path)
+    end
+
+    it 'places e2e_helper.rb where middleware expects it (install_folder/e2e_helper.rb)' do
+      # Middleware looks for #{install_folder}/e2e_helper.rb
+      helper_path = File.join(destination_root, 'e2e', 'e2e_helper.rb')
+      expect(File).to exist(helper_path)
+      expect(File.read(helper_path)).to include('CypressOnRails')
+    end
+
+    it 'places app_commands where middleware expects it (install_folder/app_commands)' do
+      # Middleware looks for #{install_folder}/app_commands/#{command}.rb
+      commands_path = File.join(destination_root, 'e2e', 'app_commands')
+      expect(File).to be_directory(commands_path)
+
+      # Check that command files exist
+      clean_cmd = File.join(commands_path, 'clean.rb')
+      expect(File).to exist(clean_cmd)
+    end
+
+    it 'places cypress.config.js where cypress --project flag expects it' do
+      # Cypress runs with --project install_folder, expects config at that level
+      config_path = File.join(destination_root, 'e2e', 'cypress.config.js')
+      expect(File).to exist(config_path)
+
+      # Verify the config references the correct relative path for support files
+      content = File.read(config_path)
+      expect(content).to include('cypress/support/index.js')
+    end
+
+    it 'creates a valid directory structure' do
+      # The expected structure:
+      # e2e/
+      #   cypress.config.js       <- Config at root of install_folder
+      #   e2e_helper.rb           <- Helper at root of install_folder
+      #   app_commands/           <- Commands at root of install_folder
+      #   cypress/                <- Framework-specific subdirectory
+      #     support/
+      #     e2e/
+
+      expect(File).to exist(File.join(destination_root, 'e2e', 'cypress.config.js'))
+      expect(File).to exist(File.join(destination_root, 'e2e', 'e2e_helper.rb'))
+      expect(File).to be_directory(File.join(destination_root, 'e2e', 'app_commands'))
+      expect(File).to be_directory(File.join(destination_root, 'e2e', 'cypress'))
+      expect(File).to be_directory(File.join(destination_root, 'e2e', 'cypress', 'support'))
+      expect(File).to be_directory(File.join(destination_root, 'e2e', 'cypress', 'e2e'))
+    end
+  end
+
+  def run_generator(args, options)
+    generator_options = []
+    options.each do |key, value|
+      generator_options << "--#{key}=#{value}"
+    end
+
+    CypressOnRails::InstallGenerator.start(
+      args + generator_options,
+      {
+        destination_root: destination_root,
+        shell: Thor::Shell::Basic.new,
+        behavior: :invoke
+      }
+    )
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cypress-on-rails
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.20.0
 platform: ruby
 authors:
 - miceportal team
@@ -94,7 +94,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Integrates cypress with rails or rack applications
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integrates Cypress and Playwright with Rails or Rack applications
 email:
 - info@miceportal.de
 - grantspeelman@gmail.com
@@ -103,6 +117,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/claude-code-review.yml"
+- ".github/workflows/claude.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -110,8 +126,15 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- RELEASING.md
 - Rakefile
 - cypress-on-rails.gemspec
+- docs/BEST_PRACTICES.md
+- docs/DX_IMPROVEMENTS.md
+- docs/PLAYWRIGHT_GUIDE.md
+- docs/RELEASE.md
+- docs/TROUBLESHOOTING.md
+- docs/VCR_GUIDE.md
 - docs/authentication.md
 - docs/factory_bot_associations.md
 - lib/cypress-on-rails.rb
@@ -124,8 +147,10 @@ files:
 - lib/cypress_on_rails/middleware.rb
 - lib/cypress_on_rails/middleware_config.rb
 - lib/cypress_on_rails/railtie.rb
+- lib/cypress_on_rails/server.rb
 - lib/cypress_on_rails/simple_rails_factory.rb
 - lib/cypress_on_rails/smart_factory_wrapper.rb
+- lib/cypress_on_rails/state_reset_middleware.rb
 - lib/cypress_on_rails/vcr/insert_eject_middleware.rb
 - lib/cypress_on_rails/vcr/middleware_helpers.rb
 - lib/cypress_on_rails/vcr/use_cassette_middleware.rb
@@ -153,10 +178,14 @@ files:
 - lib/generators/cypress_on_rails/templates/spec/playwright/e2e/rails_examples/using_scenarios.spec.js
 - lib/generators/cypress_on_rails/templates/spec/playwright/support/index.js.erb
 - lib/generators/cypress_on_rails/templates/spec/playwright/support/on-rails.js
+- lib/tasks/cypress.rake
 - plugin/.gitignore
 - plugin/cypress/plugins/index.js
 - plugin/package.json
 - plugin/support/index.js
+- rakelib/release.rake
+- rakelib/task_helpers.rb
+- rakelib/update_changelog.rake
 - spec/cypress_on_rails/command_executor/e2e_helper.rb
 - spec/cypress_on_rails/command_executor/test_command.rb
 - spec/cypress_on_rails/command_executor/test_command_with_options.rb
@@ -168,6 +197,7 @@ files:
 - spec/cypress_on_rails/smart_factory_wrapper_spec.rb
 - spec/cypress_on_rails/vcr/insert_eject_middleware_spec.rb
 - spec/cypress_on_rails/vcr/use_cassette_middleware_spec.rb
+- spec/generators/install_generator_spec.rb
 - spec/spec_helper.rb
 - specs_e2e/cypress.config.js
 - specs_e2e/playwright.config.js
@@ -405,7 +435,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.7
 specification_version: 4
-summary: Integrates cypress with rails or rack applications
+summary: Integrates Cypress and Playwright with Rails or Rack applications
 test_files: []