smartest 0.3.0 → 0.3.1.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71422e8f16922c132f0fb06024693ff0d7b502fe6cd2c6050491f1605b105daa
-  data.tar.gz: a1c14eb9ab5448753a4e5f1b04faab8ade071b31e8943ed4f34f821c88722477
+  metadata.gz: f0ad4d0e55a491b021ce003225cabcec5ceef4e2f3fbfd5f24c5bfbb8064a65b
+  data.tar.gz: ea6b00342dfccdac90f904f90684af1ff69a75865ccaaf50b74803d7fdfd8cfb
 SHA512:
-  metadata.gz: b5850a77ec4f8ac2d7b887151b5439af643928d9b62bb08c444c1b93f8a3eef4381f9bc0ad78d070c11cbde1d115d9fdb59c88f24535513ef3c819070206ba73
-  data.tar.gz: 9ac959479ddfdc0979a9a9bb9a11e9366f53d2cb03aecef02f96fff01c3417f9cc42c0ee87b954ccc7176171120b7b711dfb105fe40dd665e61a08a6af6ebd07
+  metadata.gz: '099d26d094f730b421d3cfe2d09c8a9391f13a1949e111c00c4c3612fa22510f6403db236a87ca352f4646a695fffc0136d3d9b804acaf0287c4d75d79c900cf'
+  data.tar.gz: f77ea77aa5cb56ecf4df7bdaf5d63537daae371997d2aeca7a66d74abc4a52add7241bb0b922e3c392306dd714405abe267af4ae65dcbeb6f0b3d8c506474a00

data/CHANGELOG.md

@@ -16,3 +16,4 @@
 - Use `smartest/**/*_test.rb` as the default CLI glob so Smartest can coexist with Minitest files under `test/`.
 - Add gem packaging metadata and release tasks.
 - Add Docusaurus documentation.
+- Add `smartest --init-browser` with a Playwright init scaffold, fixture setup, matcher generation, and dependency installation.

data/DEVELOPMENT.md

@@ -864,6 +864,5 @@ Do not implement these in the first version:
 - RSpec-compatible matcher ecosystem
 - snapshot testing
 - watch mode
-- browser automation integration
 
 These can be added after the core fixture model is stable.

data/README.md

@@ -127,6 +127,35 @@ Top 1 slowest test (0.00001 seconds, 100.0% of total time):
 1 test, 1 passed, 0 failed
 ```
 
+## Playwright quick start
+
+Initialize a browser-test scaffold:
+
+```bash
+bundle exec smartest --init-browser
+```
+
+The Playwright init command creates the normal Smartest helper, fixtures, and
+predicate matcher, then adds:
+
+```text
+smartest/fixtures/playwright_fixture.rb
+smartest/matchers/playwright_matcher.rb
+smartest/example_spec.rb
+```
+
+It also registers `PlaywrightFixture` and `PlaywrightMatcher`, adds
+`playwright-ruby-client` to the Gemfile test group, runs `bundle install`, runs
+`npm init --yes` when no `package.json` exists yet, runs
+`npm install playwright --save-dev`, and downloads Chromium with
+`./node_modules/.bin/playwright install`.
+
+Run the generated browser example with:
+
+```bash
+bundle exec smartest smartest/example_spec.rb
+```
+
 ## Defining tests
 
 Use `test` at the top level:

data/SMARTEST_DESIGN.md

@@ -787,12 +787,22 @@ class Smartest::ExpectationTarget
     if matcher.respond_to?(:does_not_match?)
       return self if matcher.does_not_match?(@actual)
 
-      raise AssertionFailed, matcher.negated_failure_message
+      raise AssertionFailed, negated_failure_message_for(matcher)
     end
 
     return self unless matcher.matches?(@actual)
 
-    raise AssertionFailed, matcher.negated_failure_message
+    raise AssertionFailed, negated_failure_message_for(matcher)
+  end
+
+  private
+
+  def negated_failure_message_for(matcher)
+    return matcher.negated_failure_message if matcher.respond_to?(:negated_failure_message)
+    return matcher.failure_message_when_negated if matcher.respond_to?(:failure_message_when_negated)
+
+    description = matcher.respond_to?(:description) ? matcher.description : matcher.inspect
+    "expected #{@actual.inspect} not to #{description}"
   end
 end
 ```

data/exe/smartest

@@ -10,6 +10,7 @@ usage = <<~USAGE
     smartest [--profile N] [paths...]
     smartest [--profile N] path/to/test_file.rb:line[-line]
     smartest --init
+    smartest --init-browser
     smartest --version
     smartest --help
 
@@ -36,6 +37,11 @@ begin
     exit Smartest::InitGenerator.new.run
   end
 
+  if ARGV.include?("--init-browser")
+    command = :init_browser
+    exit Smartest::InitBrowserGenerator.new.run
+  end
+
   Smartest.disable_autorun!
   Kernel.prepend Smartest::DSL
   test_load_path = File.expand_path("smartest", Dir.pwd)
@@ -52,7 +58,16 @@ begin
 rescue Exception => error
   raise if Smartest.fatal_exception?(error)
 
-  warn(command == :init ? "Error initializing Smartest:" : "Error loading tests:")
+  warn(
+    case command
+    when :init
+      "Error initializing Smartest:"
+    when :init_browser
+      "Error initializing Smartest browser scaffold:"
+    else
+      "Error loading tests:"
+    end
+  )
   warn "#{error.class}: #{error.message}"
   warn error.backtrace&.first
   exit 1

data/lib/smartest/expectation_target.rb

@@ -20,12 +20,22 @@ module Smartest
       if matcher.respond_to?(:does_not_match?)
         return self if matcher.does_not_match?(@actual)
 
-        raise AssertionFailed, matcher.negated_failure_message
+        raise AssertionFailed, negated_failure_message_for(matcher)
       end
 
       return self unless matcher.matches?(@actual)
 
-      raise AssertionFailed, matcher.negated_failure_message
+      raise AssertionFailed, negated_failure_message_for(matcher)
+    end
+
+    private
+
+    def negated_failure_message_for(matcher)
+      return matcher.negated_failure_message if matcher.respond_to?(:negated_failure_message)
+      return matcher.failure_message_when_negated if matcher.respond_to?(:failure_message_when_negated)
+
+      description = matcher.respond_to?(:description) ? matcher.description : matcher.inspect
+      "expected #{@actual.inspect} not to #{description}"
     end
   end
 end

data/lib/smartest/init_browser_generator.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Smartest
+  class InitBrowserGenerator
+    PLAYWRIGHT_FIXTURE = <<~RUBY
+      # frozen_string_literal: true
+
+      require "playwright"
+
+      class PlaywrightFixture < Smartest::Fixture
+        suite_fixture :playwright do
+          runtime = Playwright.create(
+            playwright_cli_executable_path: "./node_modules/.bin/playwright",
+          )
+          cleanup { runtime.stop }
+          runtime.playwright
+        end
+
+        suite_fixture :browser do |playwright:|
+          browser_type = case ENV["BROWSER"]
+          when "firefox"
+            :firefox
+          when "webkit"
+            :webkit
+          else
+            :chromium
+          end
+
+          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
+          end
+
+          browser = playwright.send(browser_type).launch(**launch_options)
+          cleanup { browser.close }
+          browser
+        end
+
+        fixture :page do |browser:|
+          context = browser.new_context
+          cleanup { context.close }
+          context.new_page
+        end
+      end
+    RUBY
+
+    PLAYWRIGHT_MATCHER = <<~RUBY
+      # frozen_string_literal: true
+
+      require "playwright"
+      require "playwright/test"
+
+      module PlaywrightMatcher
+        include Playwright::Test::Matchers
+      end
+    RUBY
+
+    EXAMPLE_SPEC = <<~RUBY
+      # frozen_string_literal: true
+
+      require "test_helper"
+
+      test("finds the smartest gem on RubyGems") do |page:|
+        page.goto("https://rubygems.org/")
+        page.locator("input[name='query']").fill("smartest")
+        page.keyboard.press("Enter")
+
+        page.locator("a[href='/gems/smartest']").click
+        expect(page).to have_url("https://rubygems.org/gems/smartest")
+        expect(page.locator(".versions")).to have_text("0.3.0.alpha1")
+      end
+    RUBY
+
+    def initialize(root: Dir.pwd, output: $stdout, command_runner: nil)
+      @root = root
+      @output = output
+      @command_runner = command_runner || method(:run_system_command)
+    end
+
+    def run
+      Smartest::InitGenerator.new(
+        root: @root,
+        output: @output,
+        files: smartest_files,
+        final_message: nil
+      ).run
+      create_file("smartest/fixtures/playwright_fixture.rb", PLAYWRIGHT_FIXTURE)
+      create_file("smartest/matchers/playwright_matcher.rb", PLAYWRIGHT_MATCHER)
+      update_test_helper
+      update_gemfile
+      install_dependencies
+      @output.puts
+      @output.puts "Run your browser test suite with: bundle exec smartest smartest/example_spec.rb"
+
+      0
+    end
+
+    private
+
+    def smartest_files
+      Smartest::InitGenerator::FILES.each_with_object({}) do |(path, contents), files|
+        next if path == "smartest/example_test.rb"
+
+        files[path] = contents
+      end.merge("smartest/example_spec.rb" => EXAMPLE_SPEC)
+    end
+
+    def create_file(path, contents)
+      absolute_path = File.join(@root, path)
+
+      if File.exist?(absolute_path)
+        @output.puts "exist   #{path}"
+        return
+      end
+
+      FileUtils.mkdir_p(File.dirname(absolute_path))
+      File.write(absolute_path, contents)
+      @output.puts "create  #{path}"
+    end
+
+    def update_test_helper
+      path = File.join(@root, "smartest/test_helper.rb")
+      contents = File.read(path)
+      updated = ensure_browser_registered(contents)
+
+      return if updated == contents
+
+      File.write(path, updated)
+      @output.puts "update  smartest/test_helper.rb"
+    end
+
+    def ensure_browser_registered(contents)
+      missing_lines = []
+      missing_lines << "  use_fixture PlaywrightFixture\n" unless contents.include?("use_fixture PlaywrightFixture")
+      missing_lines << "  use_matcher PlaywrightMatcher\n" unless contents.include?("use_matcher PlaywrightMatcher")
+      return contents if missing_lines.empty?
+
+      if contents.include?("use_matcher PredicateMatcher")
+        contents.sub(/^(\s*use_matcher PredicateMatcher\n)/) do
+          "#{Regexp.last_match(1)}#{missing_lines.join}"
+        end
+      else
+        "#{contents.chomp}\n\naround_suite do |suite|\n#{missing_lines.join}  suite.run\nend\n"
+      end
+    end
+
+    def update_gemfile
+      path = File.join(@root, "Gemfile")
+      exists = File.exist?(path)
+      contents = exists ? File.read(path) : "source \"https://rubygems.org\"\n"
+
+      if contents.match?(/gem ["']playwright-ruby-client["']/)
+        @output.puts "exist   Gemfile playwright-ruby-client"
+        return
+      end
+
+      separator = contents.end_with?("\n") ? "" : "\n"
+      updated = "#{contents}#{separator}\ngem \"playwright-ruby-client\", group: :test\n"
+      File.write(path, updated)
+      @output.puts(exists ? "update  Gemfile" : "create  Gemfile")
+    end
+
+    def install_dependencies
+      install_commands.each do |command|
+        @output.puts "run     #{command.join(" ")}"
+        next if @command_runner.call(command, chdir: @root)
+
+        raise "command failed: #{command.join(" ")}"
+      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
+    end
+
+    def run_system_command(command, chdir:)
+      system(*command, chdir: chdir)
+    end
+  end
+end

data/lib/smartest/init_generator.rb

@@ -88,19 +88,23 @@ module Smartest
       RUBY
     }.freeze
 
-    def initialize(root: Dir.pwd, output: $stdout)
+    def initialize(root: Dir.pwd, output: $stdout, files: FILES, final_message: "Run your test suite with: bundle exec smartest")
       @root = root
       @output = output
+      @files = files
+      @final_message = final_message
     end
 
     def run
       create_directory("smartest")
       create_directory("smartest/fixtures")
       create_directory("smartest/matchers")
-      FILES.each { |path, contents| create_file(path, contents) }
+      @files.each { |path, contents| create_file(path, contents) }
 
-      @output.puts
-      @output.puts "Run your test suite with: bundle exec smartest"
+      if @final_message
+        @output.puts
+        @output.puts @final_message
+      end
 
       0
     end

data/lib/smartest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Smartest
-  VERSION = "0.3.0"
+  VERSION = "0.3.1.alpha4"
 end

data/lib/smartest.rb

@@ -25,6 +25,7 @@ require_relative "smartest/test_result"
 require_relative "smartest/reporter"
 require_relative "smartest/runner"
 require_relative "smartest/init_generator"
+require_relative "smartest/init_browser_generator"
 require_relative "smartest/cli_arguments"
 
 module Smartest

data/smartest/smartest_test.rb

@@ -268,6 +268,24 @@ test("rejects negated matcher composition") do
   expect(error.message).to eq("not_to does not support matcher composition with .and or .or")
 end
 
+test("not_to supports RSpec-style failure_message_when_negated") do
+  matcher = Class.new do
+    def matches?(_actual)
+      true
+    end
+
+    def failure_message_when_negated
+      "expected negated failure message"
+    end
+  end
+
+  error = SmartestSelfTest.capture_error(Smartest::AssertionFailed) do
+    expect("value").not_to matcher.new
+  end
+
+  expect(error.message).to eq("expected negated failure message")
+end
+
 test("short-circuits or matcher composition") do
   right_matcher = Class.new(Smartest::Matcher) do
     def matches?(_actual)
@@ -1641,6 +1659,7 @@ test("cli prints help") do
   expect(stdout).to include("smartest [--profile N] [paths...]")
   expect(stdout).to include("smartest [--profile N] path/to/test_file.rb:line[-line]")
   expect(stdout).to include("smartest --init")
+  expect(stdout).to include("smartest --init-browser")
   expect(stdout).to include("Use --profile N")
   expect(stdout).to include("smartest/**/*_test.rb")
 end
@@ -1982,3 +2001,92 @@ test("cli init does not overwrite existing scaffold files") do
     expect(File.read(matcher_path)).to eq("# custom matcher\n")
   end
 end
+
+test("cli browser init generator creates Playwright scaffold and installation commands") do
+  Dir.mktmpdir do |dir|
+    File.write(File.join(dir, "Gemfile"), <<~RUBY)
+      source "https://rubygems.org"
+
+      gem "smartest"
+    RUBY
+
+    commands = []
+    output = StringIO.new
+    generator = Smartest::InitBrowserGenerator.new(
+      root: dir,
+      output: output,
+      command_runner: ->(command, chdir:) {
+        commands << [command, chdir]
+        true
+      }
+    )
+
+    status = generator.run
+
+    expect(status).to eq(0)
+    expect(File.exist?(File.join(dir, "smartest/example_test.rb"))).to eq(false)
+    expect(File.read(File.join(dir, "smartest/example_spec.rb"))).to include("finds the smartest gem on RubyGems")
+    expect(File.read(File.join(dir, "smartest/example_spec.rb"))).to include('expect(page).to have_url("https://rubygems.org/gems/smartest")')
+    expect(File.read(File.join(dir, "smartest/fixtures/playwright_fixture.rb"))).to include("class PlaywrightFixture < Smartest::Fixture")
+    expect(File.read(File.join(dir, "smartest/fixtures/playwright_fixture.rb"))).to include('require "playwright"')
+    expect(File.read(File.join(dir, "smartest/fixtures/playwright_fixture.rb"))).to include('playwright_cli_executable_path: "./node_modules/.bin/playwright"')
+    expect(File.read(File.join(dir, "smartest/fixtures/playwright_fixture.rb"))).to include("launch_options[:slowMo] = slow_mo")
+    expect(File.read(File.join(dir, "smartest/matchers/playwright_matcher.rb"))).to include("module PlaywrightMatcher")
+    expect(File.read(File.join(dir, "smartest/matchers/playwright_matcher.rb"))).to include("include Playwright::Test::Matchers")
+
+    helper_contents = File.read(File.join(dir, "smartest/test_helper.rb"))
+    expect(helper_contents).to include('require "smartest/autorun"')
+    expect(helper_contents).not_to include("smartest-playwright")
+    expect(helper_contents).to include("use_matcher PredicateMatcher\n  use_fixture PlaywrightFixture\n  use_matcher PlaywrightMatcher\n  suite.run")
+
+    gemfile_contents = File.read(File.join(dir, "Gemfile"))
+    expect(gemfile_contents).to include('gem "playwright-ruby-client", group: :test')
+    expect(commands).to eq(
+      [
+        [["bundle", "install"], dir],
+        [["npm", "init", "--yes"], dir],
+        [["npm", "install", "playwright", "--save-dev"], dir],
+        [["./node_modules/.bin/playwright", "install"], dir]
+      ]
+    )
+    expect(output.string).to include("run     bundle install")
+    expect(output.string).to include("run     npm init --yes")
+    expect(output.string).to include("run     npm install playwright --save-dev")
+    expect(output.string).to include("run     ./node_modules/.bin/playwright install")
+    expect(output.string).to include("Run your browser test suite with: bundle exec smartest smartest/example_spec.rb")
+  end
+end
+
+test("cli browser init generator skips npm init when package.json already exists") do
+  Dir.mktmpdir do |dir|
+    File.write(File.join(dir, "Gemfile"), <<~RUBY)
+      source "https://rubygems.org"
+
+      gem "smartest"
+    RUBY
+    File.write(File.join(dir, "package.json"), "{\n  \"name\": \"existing\"\n}\n")
+
+    commands = []
+    output = StringIO.new
+    generator = Smartest::InitBrowserGenerator.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", "install", "playwright", "--save-dev"], dir],
+        [["./node_modules/.bin/playwright", "install"], dir]
+      ]
+    )
+    expect(output.string).not_to include("npm init --yes")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartest
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1.alpha4
 platform: ruby
 authors:
 - Yusuke Iwaki
@@ -54,6 +54,7 @@ files:
 - lib/smartest/fixture_set.rb
 - lib/smartest/helper_registry.rb
 - lib/smartest/hook_contexts.rb
+- lib/smartest/init_browser_generator.rb
 - lib/smartest/init_generator.rb
 - lib/smartest/matcher_registry.rb
 - lib/smartest/matchers.rb
@@ -91,9 +92,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.19
 signing_key: