smartest 0.6.0.alpha1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a400f8b0fb05816a1adae02b69ce475d81bd63ad3516dded34fc47b3efc516
-  data.tar.gz: eeef5df2ac8161d3998fb942e7796ccfead8f7f8409b835c771fec4db7756137
+  metadata.gz: 6c8e44520f35d8daac5d01122fd2dc2b1f70f0fcbc61c1ff1d2a6c8ce5179a72
+  data.tar.gz: 4400e77b387079fa88978ff82d34b492f250fdf6de75aae773911a5b91672169
 SHA512:
-  metadata.gz: 8336c21065222424824f95636730ab6ba1683fff0f711a3d37d180bebe6bac8cbf95be4c9bb8e0a794f0719fb5ba86102703d5af99902c1ab8461b5de0f6ab7c
-  data.tar.gz: 067c9a2f862cf07035b50bc8783e92f919a68ec8000546b2ab96e0ed2bde7c8cb0b811d99f7e9bf8bb2983d85ac7883fd830a38f86930c5a688b6e800f459fb7
+  metadata.gz: b5f7dde5de541b2eec20747164936cee3945076fb985c636d4ae2ea2473e0e2b795b9e5b393800b198e2bae5ae8c6e0892ab173d74e995404a1f4941ce27fd57
+  data.tar.gz: 0226224e48d5dfcaa82b9b22fc03ab295cab9fd463f5f0e17bab881d38e9f68eb98946641a45f5b6a13a884d1649c714a6e8aacd86e772b1aa6ec9d82fbf323c

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.6.0 (not published yet)
+## 0.6.0
 
 ### New Features
 

data/README.md

@@ -262,9 +262,27 @@ process as the test runner. `Smartest::Rails::TestServer` is only loaded by
 explicitly requiring `smartest/rails`; plain `require "smartest"` does not load
 Puma.
 
+This is aimed at local Rails system tests that combine Rails test data, stubs,
+and Playwright browser assertions. It is not a Capybara compatibility layer or
+the main choice for staging / production-like E2E suites; use Node.js
+Playwright Test for that style of E2E testing.
+
 The generated `page` fixture uses a per-test Playwright browser context with
-`baseURL` set to the Rails server URL. Set `SMARTEST_RAILS_PORT` when you need a
-fixed port; otherwise the test server asks the OS for an available port.
+`baseURL` set to the Rails server URL. Set
+`SMARTEST_RAILS_TEST_SERVER_PORT` when you need a fixed port; otherwise the test
+server asks the OS for an available port.
+
+For Docker sidecar runs, initialize without installing browser binaries into
+the Rails app container:
+
+```bash
+SMARTEST_SKIP_BROWSER_DOWNLOAD=1 bundle exec smartest --init-rails
+```
+
+At runtime, set `PLAYWRIGHT_WS_ENDPOINT`,
+`SMARTEST_RAILS_TEST_SERVER_HOST`, `SMARTEST_RAILS_TEST_SERVER_PORT`, and
+`SMARTEST_RAILS_BASE_URL` so the generated fixture connects to the Playwright
+sidecar and gives the browser a Docker-network URL for Rails.
 
 Run the generated Rails browser example with:
 

data/lib/smartest/init_rails_generator.rb

@@ -10,7 +10,7 @@ module Smartest
       require 'smartest/rails'
       require "playwright"
 
-      class RailsSystemFixture < Smartest::Fixture
+      class RailsSystemTestFixture < Smartest::Fixture
         suite_fixture :rails_server do
           # Set the environment before loading config/environment so the test
           # server cannot boot against the development database by default.
@@ -18,7 +18,11 @@ module Smartest
           ENV["RACK_ENV"] ||= ENV["RAILS_ENV"]
           require_relative "../../config/environment"
 
-          server = Smartest::Rails::TestServer.new(app: Rails.application)
+          server = Smartest::Rails::TestServer.new(
+            app: Rails.application,
+            host: ENV["SMARTEST_RAILS_TEST_SERVER_HOST"],
+            port: ENV["SMARTEST_RAILS_TEST_SERVER_PORT"],
+          )
           server.start
           server.wait_for_ready
 
@@ -31,36 +35,34 @@ module Smartest
         end
 
         suite_fixture :base_url do |rails_server:|
-          rails_server.base_url
+          ENV.fetch("SMARTEST_RAILS_BASE_URL", rails_server.base_url)
         end
 
-        suite_fixture :playwright do
-          runtime = Playwright.create(
-            playwright_cli_executable_path: "./node_modules/.bin/playwright",
-          )
-          on_teardown { runtime.stop }
-          runtime.playwright
-        end
+        suite_fixture :browser do
+          ws_endpoint = ENV["PLAYWRIGHT_WS_ENDPOINT"]
 
-        suite_fixture :browser do |playwright:|
-          browser_type = case ENV["BROWSER"]
-          when "firefox"
-            :firefox
-          when "webkit"
-            :webkit
-          else
-            :chromium
-          end
+          if ws_endpoint && !ws_endpoint.empty?
+            playwright_execution = Playwright.connect_to_browser_server(
+              ws_endpoint,
+              browser_type: selected_browser_type.to_s,
+            )
+            on_teardown { playwright_execution.stop }
 
-          launch_options = {}
-          launch_options[:headless] = !%w[0 false].include?(ENV["HEADLESS"])
-          if (slow_mo = ENV["SLOW_MO"].to_i) > 0
-            launch_options[:slowMo] = slow_mo
+            playwright_execution.browser
+          else
+            playwright_execution = Playwright.create(
+              playwright_cli_executable_path: ENV.fetch(
+                "PLAYWRIGHT_CLI_EXECUTABLE_PATH",
+                "./node_modules/.bin/playwright",
+              )
+            )
+            on_teardown { playwright_execution.stop }
+
+            playwright = playwright_execution.playwright
+            browser = playwright.public_send(selected_browser_type).launch(**browser_launch_options)
+            on_teardown { browser.close }
+            browser
           end
-
-          browser = playwright.send(browser_type).launch(**launch_options)
-          on_teardown { browser.close }
-          browser
         end
 
         fixture :browser_context do |base_url:, browser:|
@@ -74,6 +76,29 @@ module Smartest
           on_teardown { page.close }
           page
         end
+
+        private
+
+        def selected_browser_type
+          case ENV.fetch("BROWSER", "chromium")
+          when "firefox"
+            :firefox
+          when "webkit"
+            :webkit
+          else
+            :chromium
+          end
+        end
+
+        def browser_launch_options
+          launch_options = {}
+          launch_options[:headless] = !%w[0 false].include?(ENV.fetch("HEADLESS", "true"))
+          if (slow_mo = ENV.fetch("SLOW_MO", "0").to_i) > 0
+            launch_options[:slowMo] = slow_mo
+          end
+
+          launch_options
+        end
       end
     RUBY
 
@@ -156,7 +181,7 @@ module Smartest
 
     def ensure_rails_registered(contents)
       missing_lines = []
-      missing_lines << "  use_fixture RailsSystemFixture\n" unless contents.include?("use_fixture RailsSystemFixture")
+      missing_lines << "  use_fixture RailsSystemTestFixture\n" unless contents.include?("use_fixture RailsSystemTestFixture")
       missing_lines << "  use_matcher PlaywrightMatcher\n" unless contents.include?("use_matcher PlaywrightMatcher")
       return contents if missing_lines.empty?
 
@@ -192,16 +217,24 @@ module Smartest
 
         raise "command failed: #{command.join(" ")}"
       end
+
+      if skip_browser_download?
+        @output.puts "skip    ./node_modules/.bin/playwright install (SMARTEST_SKIP_BROWSER_DOWNLOAD=1)"
+      end
     end
 
     def install_commands
       commands = [["bundle", "install"]]
       commands << ["npm", "init", "--yes"] unless File.exist?(File.join(@root, "package.json"))
       commands << ["npm", "install", "playwright", "--save-dev"]
-      commands << ["./node_modules/.bin/playwright", "install"]
+      commands << ["./node_modules/.bin/playwright", "install"] unless skip_browser_download?
       commands
     end
 
+    def skip_browser_download?
+      %w[1 true].include?(ENV.fetch("SMARTEST_SKIP_BROWSER_DOWNLOAD", "false"))
+    end
+
     def run_system_command(command, chdir:)
       system(*command, chdir: chdir)
     end

data/lib/smartest/rails.rb

@@ -9,15 +9,14 @@ require_relative "../smartest"
 module Smartest
   module Rails
     class TestServer
-      DEFAULT_HOST = "127.0.0.1"
       DEFAULT_READY_TIMEOUT = 10
 
       attr_reader :host, :port
 
-      def initialize(app:, host: DEFAULT_HOST, port: nil)
+      def initialize(app:, host: nil, port: nil)
         @app = app
-        @host = host
-        @requested_port = port || ENV["SMARTEST_RAILS_PORT"]&.to_i || 0
+        @host = host || "127.0.0.1"
+        @requested_port = port ? port.to_i : 0
         @server = Puma::Server.new(@app)
         @port = bind_tcp_listener
         @thread = nil

data/lib/smartest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Smartest
-  VERSION = "0.6.0.alpha1"
+  VERSION = "0.6.0"
 end

data/smartest/smartest_test.rb

@@ -9,6 +9,8 @@ require "open3"
 require "tmpdir"
 
 module SmartestSelfTest
+  ENV_MISSING = Object.new.freeze
+
   module_function
 
   def test_case(name, block)
@@ -40,6 +42,20 @@ module SmartestSelfTest
   else
     raise Smartest::AssertionFailed, "expected #{expected_error}, but nothing was raised"
   end
+
+  def with_env(values)
+    previous_values = {}
+    values.each do |key, value|
+      previous_values[key] = ENV.fetch(key, ENV_MISSING)
+      value.nil? ? ENV.delete(key) : ENV[key] = value
+    end
+
+    yield
+  ensure
+    previous_values.each do |key, value|
+      value.equal?(ENV_MISSING) ? ENV.delete(key) : ENV[key] = value
+    end
+  end
 end
 
 class SelfTestRegisteredFixture < Smartest::Fixture
@@ -2230,7 +2246,7 @@ test("smartest rails helper is loaded only by explicit require") do
   end
 end
 
-test("smartest rails test server wraps puma with env port and lifecycle") do
+test("smartest rails test server wraps puma with explicit arguments and lifecycle") do
   lib_path = File.expand_path("../lib", __dir__)
 
   Dir.mktmpdir do |dir|
@@ -2269,25 +2285,32 @@ test("smartest rails test server wraps puma with env port and lifecycle") do
     RUBY
 
     stdout, stderr, status = Open3.capture3(
-      { "RUBYLIB" => "#{dir}:#{lib_path}", "SMARTEST_RAILS_PORT" => "4567" },
+      {
+        "RUBYLIB" => "#{dir}:#{lib_path}",
+        "SMARTEST_RAILS_TEST_SERVER_HOST" => "0.0.0.0",
+        "SMARTEST_RAILS_TEST_SERVER_PORT" => "9876",
+        "SMARTEST_RAILS_BASE_URL" => "http://app:9876"
+      },
       "ruby",
       "-e",
       <<~'RUBY'
         require "smartest/rails"
 
-        server = Smartest::Rails::TestServer.new(app: Object.new)
+        server = Smartest::Rails::TestServer.new(app: Object.new, port: "4567")
+        default_port_server = Smartest::Rails::TestServer.new(app: Object.new)
         thread = server.start
         server.stop
         server.wait_for_stopped
 
         puts server.base_url
+        puts default_port_server.base_url
         puts thread.is_a?(Thread)
       RUBY
     )
 
     expect(status.success?).to eq(true)
     expect(stderr).to eq("")
-    expect(stdout).to eq("http://127.0.0.1:4567\ntrue\n")
+    expect(stdout).to eq("http://127.0.0.1:4567\nhttp://127.0.0.1:4321\ntrue\n")
   end
 end
 
@@ -2316,14 +2339,38 @@ test("cli rails init generator creates Rails browser scaffold and installation c
     expect(status).to eq(0)
     rails_fixture = File.read(File.join(dir, "smartest/fixtures/rails_system_fixture.rb"))
     expect(rails_fixture).to include("require 'smartest/rails'")
-    expect(rails_fixture).to include("class RailsSystemFixture < Smartest::Fixture")
+    expect(rails_fixture).to include("class RailsSystemTestFixture < Smartest::Fixture")
     expect(rails_fixture).to include("suite_fixture :rails_server")
     expect(rails_fixture).to include("server cannot boot against the development database")
     expect(rails_fixture).to include('require_relative "../../config/environment"')
-    expect(rails_fixture).to include("Smartest::Rails::TestServer.new(app: Rails.application)")
+    expect(rails_fixture).to include("Smartest::Rails::TestServer.new(")
+    expect(rails_fixture).to include('host: ENV["SMARTEST_RAILS_TEST_SERVER_HOST"]')
+    expect(rails_fixture).not_to include("bind_host:")
+    expect(rails_fixture).to include('port: ENV["SMARTEST_RAILS_TEST_SERVER_PORT"]')
+    expect(rails_fixture).not_to include("public_base_url")
     expect(rails_fixture).not_to include("SmartestRailsTestServer")
     expect(rails_fixture).not_to include("Puma::Server")
     expect(rails_fixture).to include("suite_fixture :base_url")
+    expect(rails_fixture).to include('ENV.fetch("SMARTEST_RAILS_BASE_URL", rails_server.base_url)')
+    expect(rails_fixture).not_to include("rails_test_server_port")
+    expect(rails_fixture).not_to include("SMARTEST_RAILS_PORT")
+    expect(rails_fixture).to include('ws_endpoint = ENV["PLAYWRIGHT_WS_ENDPOINT"]')
+    expect(rails_fixture).not_to include("suite_fixture :playwright_execution")
+    expect(rails_fixture).not_to include("suite_fixture :playwright do")
+    expect(rails_fixture).not_to include("Playwright.connect_to_playwright_server")
+    expect(rails_fixture).not_to include("rescue NotImplementedError")
+    expect(rails_fixture).to include("playwright_execution = Playwright.connect_to_browser_server(")
+    expect(rails_fixture).to include("browser_type: selected_browser_type.to_s")
+    expect(rails_fixture).to include("playwright_execution.browser")
+    expect(rails_fixture).to include('ENV.fetch(')
+    expect(rails_fixture).to include('"PLAYWRIGHT_CLI_EXECUTABLE_PATH"')
+    expect(rails_fixture).to include("suite_fixture :browser do")
+    expect(rails_fixture).to include("playwright_execution = Playwright.create(")
+    expect(rails_fixture).to include("on_teardown { playwright_execution.stop }")
+    expect(rails_fixture).to include("playwright = playwright_execution.playwright")
+    expect(rails_fixture).to include("playwright.public_send(selected_browser_type).launch(**browser_launch_options)")
+    expect(rails_fixture).to include("def selected_browser_type")
+    expect(rails_fixture).to include("def browser_launch_options")
     expect(rails_fixture).to include("fixture :browser_context do |base_url:, browser:|")
     expect(rails_fixture).to include("context = browser.new_context(baseURL: base_url)")
     expect(rails_fixture).to include("fixture :page do |browser_context:|")
@@ -2334,7 +2381,7 @@ test("cli rails init generator creates Rails browser scaffold and installation c
     expect(example_test).to include("expect(response.status).to be_between(200, 599)")
 
     helper_contents = File.read(File.join(dir, "smartest/test_helper.rb"))
-    expect(helper_contents).to include("use_matcher PredicateMatcher\n  use_fixture RailsSystemFixture\n  use_matcher PlaywrightMatcher\n  suite.run")
+    expect(helper_contents).to include("use_matcher PredicateMatcher\n  use_fixture RailsSystemTestFixture\n  use_matcher PlaywrightMatcher\n  suite.run")
     expect(helper_contents).not_to include("Smartest::SimpleStub")
 
     gemfile_contents = File.read(File.join(dir, "Gemfile"))
@@ -2351,6 +2398,44 @@ test("cli rails init generator creates Rails browser scaffold and installation c
   end
 end
 
+test("cli rails init generator skips browser install when requested by environment") do
+  SmartestSelfTest.with_env("SMARTEST_SKIP_BROWSER_DOWNLOAD" => "1") do
+    Dir.mktmpdir do |dir|
+      File.write(File.join(dir, "Gemfile"), <<~RUBY)
+        source "https://rubygems.org"
+
+        gem "rails"
+        gem "smartest"
+      RUBY
+
+      commands = []
+      output = StringIO.new
+      generator = Smartest::InitRailsGenerator.new(
+        root: dir,
+        output: output,
+        command_runner: ->(command, chdir:) {
+          commands << [command, chdir]
+          true
+        }
+      )
+
+      status = generator.run
+
+      expect(status).to eq(0)
+      expect(commands).to eq(
+        [
+          [["bundle", "install"], dir],
+          [["npm", "init", "--yes"], dir],
+          [["npm", "install", "playwright", "--save-dev"], dir]
+        ]
+      )
+      expect(output.string).to include("skip    ./node_modules/.bin/playwright install (SMARTEST_SKIP_BROWSER_DOWNLOAD=1)")
+      expect(File.exist?(File.join(dir, "smartest/fixtures/rails_system_fixture.rb"))).to eq(true)
+      expect(File.exist?(File.join(dir, "smartest/example_rails_system_test.rb"))).to eq(true)
+    end
+  end
+end
+
 test("cli rails init generator skips duplicate registration and dependencies") do
   Dir.mktmpdir do |dir|
     FileUtils.mkdir_p(File.join(dir, "smartest/fixtures"))
@@ -2367,7 +2452,7 @@ test("cli rails init generator skips duplicate registration and dependencies") d
 
       around_suite do |suite|
         use_matcher PredicateMatcher
-        use_fixture RailsSystemFixture
+        use_fixture RailsSystemTestFixture
         use_matcher PlaywrightMatcher
         suite.run
       end
@@ -2388,7 +2473,7 @@ test("cli rails init generator skips duplicate registration and dependencies") d
 
     expect(status).to eq(0)
     helper_contents = File.read(File.join(dir, "smartest/test_helper.rb"))
-    expect(helper_contents.scan("use_fixture RailsSystemFixture").length).to eq(1)
+    expect(helper_contents.scan("use_fixture RailsSystemTestFixture").length).to eq(1)
     expect(helper_contents.scan("use_matcher PlaywrightMatcher").length).to eq(1)
     expect(helper_contents).not_to include("Smartest::SimpleStub")
     expect(commands).to eq(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartest
 version: !ruby/object:Gem::Version
-  version: 0.6.0.alpha1
+  version: 0.6.0
 platform: ruby
 authors:
 - Yusuke Iwaki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-07 00:00:00.000000000 Z
+date: 2026-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -103,9 +103,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.19
 signing_key: