e2e 0.3.2

data/lib/e2e/matchers.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+if defined?(RSpec::Matchers)
+  RSpec::Matchers.define :have_class do |expected_class|
+    match do |element|
+      element.has_class?(expected_class)
+    end
+
+    failure_message do |element|
+      "expected element to have class '#{expected_class}', but it had '#{element.classes.join(" ")}'"
+    end
+
+    failure_message_when_negated do |element|
+      "expected element not to have class '#{expected_class}', but it did"
+    end
+  end
+
+  RSpec::Matchers.define :have_text do |expected_text|
+    match do |element|
+      if expected_text.is_a?(Regexp)
+        element.text.match?(expected_text)
+      else
+        element.text.include?(expected_text)
+      end
+    end
+
+    failure_message do |element|
+      "expected element to have text '#{expected_text}', but it had '#{element.text}'"
+    end
+
+    failure_message_when_negated do |element|
+      "expected element not to have text '#{expected_text}', but it did"
+    end
+  end
+
+  RSpec::Matchers.alias_matcher :have_content, :have_text
+
+  RSpec::Matchers.define :have_value do |expected_value|
+    match do |element|
+      element.value == expected_value
+    end
+
+    failure_message do |element|
+      "expected element to have value '#{expected_value}', but it had '#{element.value}'"
+    end
+
+    failure_message_when_negated do |element|
+      "expected element not to have value '#{expected_value}', but it did"
+    end
+  end
+
+  RSpec::Matchers.define :have_attribute do |attribute, expected_value|
+    match do |element|
+      element[attribute] == expected_value
+    end
+
+    failure_message do |element|
+      "expected element to have attribute '#{attribute}' with value '#{expected_value}', but it had '#{element[attribute]}'"
+    end
+
+    failure_message_when_negated do |element|
+      "expected element not to have attribute '#{attribute}' with value '#{expected_value}', but it did"
+    end
+  end
+
+  RSpec::Matchers.define :be_checked do
+    match do |element|
+      element.checked?
+    end
+
+    failure_message do |element|
+      "expected element to be checked, but it wasn't"
+    end
+
+    failure_message_when_negated do |element|
+      "expected element not to be checked, but it was"
+    end
+  end
+
+  RSpec::Matchers.define :be_disabled do
+    match do |element|
+      element.disabled?
+    end
+
+    failure_message do |element|
+      "expected element to be disabled, but it was enabled"
+    end
+
+    failure_message_when_negated do |element|
+      "expected element to be enabled, but it was disabled"
+    end
+  end
+
+  RSpec::Matchers.define :be_enabled do
+    match do |element|
+      element.enabled?
+    end
+
+    failure_message do |element|
+      "expected element to be enabled, but it was disabled"
+    end
+
+    failure_message_when_negated do |element|
+      "expected element to be disabled, but it was enabled"
+    end
+  end
+end

data/lib/e2e/minitest.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "minitest"
+require "e2e"
+
+module E2E
+  module Minitest
+    class TestCase < ::Minitest::Test
+      include E2E::DSL
+
+      def teardown
+        take_failed_screenshot if !passed? && !skipped?
+
+        # Reset session but keep browser open for speed
+        E2E.session.reset! if E2E.instance_variable_get(:@session)
+        super
+      end
+
+      private
+
+      def take_failed_screenshot
+        screenshots_dir = File.expand_path("tmp/screenshots", Dir.pwd)
+        FileUtils.mkdir_p(screenshots_dir)
+
+        name = "#{self.class.name}_#{name}".gsub(/[^0-9A-Za-z]/, "_")
+        path = File.join(screenshots_dir, "#{name}.png")
+
+        begin
+          save_screenshot(path) # rubocop:disable Lint/Debugger
+          puts "\n[E2E] Screenshot saved to #{path}"
+        rescue => e
+          puts "\n[E2E] Failed to save screenshot: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/e2e/rails.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module E2E
+  module Rails
+    # This module allows the test thread and the server thread to share the same
+    # ActiveRecord connection. This is crucial for running tests in transactions
+    # which is much faster than using truncation.
+    module ActiveRecordSharedConnection
+      def connection
+        @shared_connection || retrieve_connection
+      end
+
+      def shared_connection=(connection)
+        @shared_connection = connection
+      end
+    end
+  end
+end
+
+# We only want to apply this when Rails is present and we want to enable it.
+def E2E.enable_shared_connection!
+  return unless defined?(ActiveRecord::Base)
+
+  ActiveRecord::Base.extend(E2E::Rails::ActiveRecordSharedConnection)
+  ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection
+end

data/lib/e2e/rspec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "e2e"
+begin
+  require "rspec/expectations"
+rescue LoadError
+end
+require_relative "matchers"
+
+RSpec.configure do |config|
+  config.include E2E::DSL, type: :e2e
+
+  config.after(:each, type: :e2e) do |example|
+    if example.exception
+      # Create tmp/screenshots directory if it doesn't exist
+      screenshots_dir = File.expand_path("tmp/screenshots", Dir.pwd)
+      FileUtils.mkdir_p(screenshots_dir)
+
+      # Generate filename based on example description
+      filename = "#{example.full_description.gsub(/[^0-9A-Za-z]/, "_")}.png"
+      path = File.join(screenshots_dir, filename)
+
+      begin
+        E2E.session.save_screenshot(path)
+      rescue => e
+        puts "Failed to save screenshot: #{e.message}"
+      end
+    end
+
+    # Reset session (clear cookies/storage) but keep browser open
+    E2E.session.reset! if E2E.instance_variable_get(:@session)
+  end
+
+  config.after(:suite) do
+    E2E.session.quit if E2E.instance_variable_get(:@session)
+  end
+end

data/lib/e2e/server.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "rack"
+require "rackup"
+require "webrick"
+require "socket"
+
+module E2E
+  class Server
+    attr_reader :app, :host, :port
+
+    def initialize(app, port: nil)
+      @app = app
+      @host = "127.0.0.1"
+      @port = port || find_available_port
+    end
+
+    def start
+      @thread = Thread.new do
+        # Use Rackup handler for Rack 3 compatibility
+        Rackup::Handler::WEBrick.run(
+          @app,
+          Host: @host,
+          Port: @port,
+          AccessLog: [],
+          Logger: WEBrick::Log.new(nil, 0) # Silence logs
+        )
+      end
+      wait_for_boot
+    end
+
+    def base_url
+      "http://#{@host}:#{@port}"
+    end
+
+    private
+
+    def find_available_port
+      server = TCPServer.new("127.0.0.1", 0)
+      port = server.addr[1]
+      server.close
+      port
+    end
+
+    def wait_for_boot
+      start_time = Time.now
+      loop do
+        socket = TCPSocket.new("127.0.0.1", @port)
+        socket.close
+        break
+      rescue Errno::ECONNREFUSED
+        raise "Server failed to boot" if Time.now - start_time > 10
+        sleep 0.1
+      end
+    end
+  end
+end

data/lib/e2e/session.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module E2E
+  class Session
+    extend Forwardable
+
+    attr_reader :driver
+
+    def_delegators :@driver, :current_url, :click, :click_button, :click_link, :fill_in, :check, :uncheck, :attach_file, :body, :evaluate, :save_screenshot, :native, :pause, :reset!, :quit
+
+    def initialize(driver_name = E2E.config.driver)
+      @driver = initialize_driver(driver_name)
+    end
+
+    def find(...)
+      @driver.find(...)
+    end
+
+    def all(...)
+      @driver.all(...)
+    end
+
+    def visit(url)
+      if url.start_with?("/") && E2E.server
+        url = "#{E2E.server.base_url}#{url}"
+      end
+      @driver.visit(url)
+    end
+
+    private
+
+    def initialize_driver(name)
+      case name
+      when :playwright
+        Drivers::Playwright.new
+      else
+        raise ArgumentError, "Unknown driver: #{name}"
+      end
+    end
+  end
+end

data/lib/e2e/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module E2E
+  VERSION = "0.3.2"
+end

data/lib/e2e.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "e2e/version"
+require_relative "e2e/driver"
+require_relative "e2e/server"
+require_relative "e2e/session"
+require_relative "e2e/dsl"
+require_relative "e2e/element"
+require_relative "e2e/rails"
+require_relative "e2e/drivers/playwright"
+
+module E2E
+  class Error < StandardError; end
+
+  class << self
+    def session
+      @session ||= Session.new
+    end
+
+    def reset_session!
+      @session&.quit
+      @session = nil
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def server
+      @server ||= if config.app
+        srv = Server.new(config.app)
+        srv.start
+        srv
+      end
+    end
+  end
+
+  class Config
+    attr_accessor :driver, :headless, :app, :browser_type
+
+    def initialize
+      @driver = :playwright
+      @browser_type = :chromium
+      @headless = ENV.fetch("HEADLESS", "true") == "true"
+      @app = nil
+    end
+  end
+end

data/lib/generators/e2e/install_generator.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module E2e
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      class_option :test_framework, type: :string, desc: "Test framework to be invoked"
+
+      def create_helper_file
+        case test_framework
+        when :rspec
+          create_rspec_helper
+        when :minitest
+          create_minitest_helper
+        else
+          say "Could not detect test framework. Please specify --test-framework=rspec or minitest.", :red
+        end
+      end
+
+      def display_instructions
+        case test_framework
+        when :rspec
+          say "E2E gem installed for RSpec! Use `require 'e2e_helper'` in specs.", :green
+        when :minitest
+          say "E2E gem installed for Minitest! Inherit from `E2E::Minitest::TestCase` in your tests.", :green
+        end
+      end
+
+      def configure_rubocop
+        return unless File.exist?(".rubocop.yml")
+
+        config_content = File.read(".rubocop.yml")
+
+        if config_content.include?("inherit_gem:")
+          inject_into_file ".rubocop.yml", after: "inherit_gem:\n" do
+            "  e2e: config/rubocop.yml\n"
+          end
+        else
+          prepend_to_file ".rubocop.yml" do
+            "inherit_gem:\n  e2e: config/rubocop.yml\n\n"
+          end
+        end
+      end
+
+      private
+
+      def test_framework
+        return options[:test_framework].to_sym if options[:test_framework]
+
+        # Check Rails configuration
+        rails_config = Rails.application.config.generators.options[:rails][:test_framework]
+        return rails_config if rails_config
+
+        # Fallback to directory detection
+        return :rspec if File.directory?("spec")
+        :minitest if File.directory?("test")
+      end
+
+      def create_rspec_helper
+        create_file "spec/e2e_helper.rb", <<~RUBY
+          # frozen_string_literal: true
+
+          require "rails_helper"
+          require "e2e/rspec"
+
+          E2E.configure do |config|
+            config.app = Rails.application
+            config.headless = ENV.fetch("HEADLESS", "true") == "true"
+          end
+
+          # If you want to use transactional tests (faster), enable shared connection:
+          # E2E.enable_shared_connection!
+
+          RSpec.configure do |config|
+            # Add additional configuration here
+          end
+        RUBY
+      end
+
+      def create_minitest_helper
+        create_file "test/e2e_helper.rb", <<~RUBY
+          # frozen_string_literal: true
+
+          require "test_helper"
+          require "e2e/minitest"
+
+          E2E.configure do |config|
+            config.app = Rails.application
+            config.headless = ENV.fetch("HEADLESS", "true") == "true"
+          end
+
+          # If you want to use transactional tests (faster), enable shared connection:
+          # E2E.enable_shared_connection!
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/e2e/templates/minitest_test.rb.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "e2e_helper"
+
+class <%= class_name %>Test < E2E::Minitest::TestCase
+  def test_works
+    visit "/"
+    # assert_includes page.body, "Home"
+  end
+end

data/lib/generators/e2e/templates/rspec_test.rb.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "e2e_helper"
+
+RSpec.describe "<%= class_name %>", type: :e2e do
+  it "works" do
+    visit "/"
+    # expect(page.body).to include("Home")
+  end
+end

data/lib/generators/e2e/test_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module E2e
+  module Generators
+    class TestGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      class_option :test_framework, type: :string, desc: "Test framework to be invoked"
+
+      def create_test_file
+        case test_framework
+        when :rspec
+          create_rspec_test
+        when :minitest
+          create_minitest_test
+        else
+          say "Could not detect test framework. Please specify --test-framework=rspec or minitest.", :red
+        end
+      end
+
+      private
+
+      def test_framework
+        return options[:test_framework].to_sym if options[:test_framework]
+
+        rails_config = Rails.application.config.generators.options[:rails][:test_framework]
+        return rails_config if rails_config
+
+        return :rspec if File.directory?("spec")
+        :minitest if File.directory?("test")
+      end
+
+      def create_rspec_test
+        template "rspec_test.rb.erb", "spec/e2e/#{file_name}_spec.rb"
+      end
+
+      def create_minitest_test
+        template "minitest_test.rb.erb", "test/e2e/#{file_name}_test.rb"
+      end
+    end
+  end
+end

data/sig/e2e.rbs

@@ -0,0 +1,4 @@
+module E2E
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end