prism_checker 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85257e035e4a88514ae52cc74f626c3773b28a3e79af092dfe28655285af022f
-  data.tar.gz: cf8a7167976cda2f9c20dfcefce982da0a95b664d1c459483275701583ecf01b
+  metadata.gz: ba46f4fc664beea6ea8ce92f28aacd290909ec228bbc75d43a28433853b51a95
+  data.tar.gz: 2db3609621ccb519163d98f0f0a18bcbbaddefb7455f5f62f211c5bc3eb6e337
 SHA512:
-  metadata.gz: 20f7f466e32972c19d7b828cae40de07c8d2f6462aac78bb891e744d89109cfefae86a71b06ded90a47f803267053bcd7c62c095bf7e86aad57b916b53f96a99
-  data.tar.gz: 4fbcb5350cc2bcde2a8877757c4afdc4b17fb367da82e3ee95e68c00c1de5b7b3e4b324919792a87ee20fa60bb99b24a71392a45cb2db9ac994e5337076e5cc2
+  metadata.gz: 49532ad537da621054457190b11ca14b0acf18af760b2dca27700e967114e9be77d25f9640b88c7221403f1e76d8d005989ea688cccbce79b968e077df171eac
+  data.tar.gz: 27ff911f88064c9f4fb7c5146876f41146c99d9952f2673af172ee0407fff7757be119888f52a9b18ce8024192843920937b9b87a79b4c54bb7775ca84d12d9b

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.1.0 - 2026-07-16
+
+### Changed
+
+- Minimum supported Ruby is now 3.3 (was 2.5).
+- `SitePrism::TimeoutError` is resolved at runtime, so both site_prism 5 and 6 are supported.
+- `site_prism` dependency narrowed to `>= 5.0, < 7`.
+- Development dependencies moved from the gemspec to the `Gemfile`.
+- Gemspec now publishes `metadata` links (source, changelog, bug tracker) and requires MFA for releases.
+
+### Removed
+
+- The `webdrivers` development dependency. Selenium Manager, bundled with
+  `selenium-webdriver >= 4.6`, resolves browser drivers instead.
+
+## 1.0.1
+
+- Sequential loading of page objects.
+
+## 1.0.0
+
+- First public release.

data/README.md

@@ -1,6 +1,19 @@
 ![ci workflow](https://github.com/prism-checker/prism_checker/actions/workflows/ci-main.yml/badge.svg)
-[![Maintainability](https://api.codeclimate.com/v1/badges/c497733cb53175decd0f/maintainability)](https://codeclimate.com/github/prism-checker/prism_checker/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/c497733cb53175decd0f/test_coverage)](https://codeclimate.com/github/prism-checker/prism_checker/test_coverage)
+
+## Contents
+
+- [Overview](#overview)
+- [Install](#install)
+- [Setup](#setup)
+- [Cheat sheet](#cheat-sheet)
+- [Examples](#examples)
+  - [Common cases](#common-cases)
+  - [HTML elements](#html-elements)
+  - [Visibility](#visibility)
+  - [Absence](#absence)
+- [Configuration](#configuration)
+  - [String comparison](#string-comparison)
+  - [Colorizer](#colorizer)
 
 ## Overview
 
@@ -8,6 +21,8 @@ PrismChecker is an extension for rspec and minitest, built on top of the [SitePr
 gem and using its page object model.
 It allows you to write short, easy-to-read browser tests with clear error messages
 
+Requires Ruby >= 3.3 and site_prism >= 5.0.
+
 Let's assume your application has the following shop cart:
 
 ![Cart](doc/images/cart.png "Cart")
@@ -95,7 +110,7 @@ describe 'Cart' do
         }
       ],
       checkout: {
-        total: '67.00',
+        total: '67.00', # deliberately wrong, to show the failure report below
         checkout_button: 'Checkout'
       }
     )
@@ -104,7 +119,8 @@ end
 
 ```
 
-In case of errors, an easy-to-read message will be displayed:
+In case of errors, an easy-to-read message will be displayed. Every key is reported with its
+own status, so the failing one is visible at a glance:
 
 ![Result](doc/images/result.png "Result")
 
@@ -122,6 +138,109 @@ gem install prism_checker_rspec
 gem install prism_checker_minitest
 ```
 
+## Setup
+
+PrismChecker drives the browser through SitePrism and Capybara, so a Capybara driver has to be
+registered as usual. Only the last two lines are PrismChecker-specific.
+
+### RSpec
+
+Adds the `be_like` matcher:
+
+```ruby
+# Gemfile
+gem 'prism_checker_rspec'
+```
+```ruby
+# spec/spec_helper.rb
+require 'capybara/rspec'
+require 'selenium-webdriver'
+require 'site_prism'
+require 'prism_checker_rspec'
+
+Capybara.register_driver :prism_checker do |app|
+  options = Selenium::WebDriver::Chrome::Options.new
+  options.add_argument('--headless=new')
+
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
+end
+
+Capybara.configure do |config|
+  config.default_driver = :prism_checker
+  config.app_host = 'http://localhost:3000'
+  # Needed so that :invisible expectations can see hidden elements
+  config.ignore_hidden_elements = false
+end
+```
+```ruby
+# spec/cart_spec.rb
+describe 'Cart' do
+  it 'is correct' do
+    page = Cart.new
+    page.load
+
+    expect(page).to be_like(header: 'Shopping Cart')
+  end
+end
+```
+
+### MiniTest
+
+Adds the `assert_page_like` assertion:
+
+```ruby
+# Gemfile
+gem 'prism_checker_minitest'
+```
+```ruby
+# test/test_helper.rb
+require 'minitest/autorun'
+require 'capybara/minitest'
+require 'site_prism'
+require 'prism_checker_minitest'
+
+# ...same Capybara.register_driver / Capybara.configure as above
+```
+```ruby
+# test/cart_test.rb
+class CartTest < Minitest::Test
+  include Capybara::DSL
+  include Capybara::Minitest::Assertions
+
+  def test_cart
+    page = Cart.new
+    page.load
+
+    assert_page_like page, header: 'Shopping Cart'
+  end
+end
+```
+
+## Cheat sheet
+
+What gets checked depends on the type of the expectation and on the inspected item.
+
+| Expectation | Checked against |
+|---|---|
+| `'text'` | `text` of an element, section or page; `value` of an input, textarea or select; `src` of an image |
+| `/regexp/` | the same values, matched as a regular expression |
+| `42` | `size` of elements/sections |
+| `[...]` | `size` of elements/sections, then each entry in turn |
+| `{...}` | element is visible, then each key in turn |
+| `true` / `false` | `checked?` of a checkbox or radio |
+| `:visible` | `visible?` |
+| `:invisible` | `visible?` is false |
+| `:absent` | `has_no_<name>?` |
+| `:absent3` | sleep 3 seconds, then `has_no_<name>?` |
+| `:empty` | value is an empty string |
+
+Inside a `{...}` expectation, keys map to Capybara methods (`text`, `value`, `checked`, `disabled`,
+`readonly`, `selected`, `multiple`) or, failing that, to HTML attributes (`class`, `id`, `src`, `alt`,
+`data-*`, ...).
+
+A page or element is always checked for being loaded or visible before its value is compared,
+so those assertions never need to be spelled out.
+
 ## Examples
 ### Common cases
 
@@ -628,6 +747,8 @@ expect(page).to be_like(article: :absent3)
 # sleep 3
 # expect(page.has_no_article?).to eq(true)
 ```
+## Configuration
+
 ### String comparison
 
 #### Exact match and inclusion
@@ -668,3 +789,23 @@ expect(page.element_without_text).to be_like(/^$/)
 # expect(page.element_without_text.visible?).to eq(true)
 # expect(page.element_without_text.text).to match(/^$/)
 ```
+
+### Colorizer
+
+Failure reports are colorized through `PrismChecker.colorizer`. `prism_checker_rspec` sets one that
+uses the RSpec console codes; the default of the core gem returns text unchanged.
+
+A colorizer answers `colorize(text, code)`, where `code` is one of `:success`, `:failure`,
+`:detail` or `:white`:
+
+```ruby
+class MyColorizer
+  CODES = { success: 32, failure: 31, detail: 33, white: 37 }.freeze
+
+  def self.colorize(text, code)
+    "\e[#{CODES[code]}m#{text}\e[0m"
+  end
+end
+
+PrismChecker.colorizer = MyColorizer
+```

data/lib/prism_checker/node/base.rb

@@ -6,6 +6,7 @@ require_relative 'bad_expectation'
 require_relative '../element_wrapper'
 require_relative '../absence_expectation'
 require_relative '../item_classifier'
+require_relative '../site_prism_compat'
 
 module PrismChecker
   module Node
@@ -67,7 +68,7 @@ module PrismChecker
 
       def wait_until_true(timeout = @timeout, &block)
         SitePrism::Waiter.wait_until_true(timeout, &block)
-      rescue SitePrism::TimeoutError
+      rescue SitePrismCompat.timeout_error
         false
       end
 

data/lib/prism_checker/site_prism_compat.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PrismChecker
+  # site_prism 6 nests its errors under SitePrism::Error, while 5 keeps them
+  # at the top level. The gem supports both, so the class is resolved on first
+  # use rather than at load time: site_prism is required by the host suite,
+  # not by prism_checker itself.
+  module SitePrismCompat
+    def self.timeout_error
+      @timeout_error ||= if SitePrism.const_defined?(:Error, false) && SitePrism::Error.const_defined?(:TimeoutError, false)
+                           SitePrism::Error::TimeoutError
+                         else
+                           SitePrism::TimeoutError
+                         end
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: prism_checker
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ganglion-17
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: site_prism
@@ -16,160 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  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'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.11.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.10.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.10.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :development
+        version: '7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: simplecov_json_formatter
-  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'
-- !ruby/object:Gem::Dependency
-  name: webdrivers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '7'
 description: |
   prism_checker is an extension for rspec and minitest, built on top of the site_prism gem and using its page object model.
   It allows you to write short, easy-to-read browser tests with clear error messages
@@ -177,8 +36,12 @@ email:
 - ganglion1717@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
 files:
+- CHANGELOG.md
 - LICENSE.md
 - README.md
 - lib/prism_checker.rb
@@ -222,11 +85,16 @@ files:
 - lib/prism_checker/node/expectation.rb
 - lib/prism_checker/node/hash.rb
 - lib/prism_checker/report_builder.rb
+- lib/prism_checker/site_prism_compat.rb
 homepage: https://github.com/prism-checker/prism_checker
 licenses:
 - BSD-3-Clause
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/prism-checker/prism_checker/issues
+  changelog_uri: https://github.com/prism-checker/prism_checker/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/prism-checker/prism_checker/blob/main/README.md
+  source_code_uri: https://github.com/prism-checker/prism_checker
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -234,15 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Short and easy-to-read browser tests with clear error messages
 test_files: []