lighthouse-matchers 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d59475b53e41779753dc20a7d0775dc4300494da79af101d2671b235d9952192
-  data.tar.gz: 41d0d01d7494075bc18d6dc3bca107f5de9ec3400cf89eac689c8834fd24efdd
+  metadata.gz: 1b73401322398ad659f111555923e60f2859c90e1e24893c209686842340de06
+  data.tar.gz: 2fec0776316b961004e8254ab49f374dc56eff5096a3336d2216294b10cbe13c
 SHA512:
-  metadata.gz: 201ae5239f163fc312f4edb460b7e9a5969757c06b7093792b7f0ff8cff7e5baccf9ec8aa8c5ac612d537bb6a371fb605c6099d833ca7b5ed918abbde2932ede
-  data.tar.gz: 2879723cd480d9e67e2578c5e89f78e6251350cd01702a3cd7150705fdf2e3245ed9319a44b929280e65d8640a4d6508b876065f9dbb5e1bbc434149e96bfe4a
+  metadata.gz: f847e1a748e9097df8a7345e60f3249f15ae9c3031885a756c9ce2a6bf582032d4de281c2f2b6c088a73baca86a7158f3101f637f9c376298b665848d1f9f7c2
+  data.tar.gz: f461dd4cc3b146228986c833857421a9861b9b65d0b1095b90f10dae40bed454009c83fc5b1dadb60ca246a43768fec984226933fd980abe81aa990681c3c715

data/.github/workflows/ci.yml

@@ -22,24 +22,35 @@ permissions:
   contents: read # to fetch code (actions/checkout)
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+    - run: bundle exec rubocop
   test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1']
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         persist-credentials: false
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - uses: actions/setup-node@v3
+    - uses: actions/setup-node@v4
       with:
         cache: 'npm'
     - run: npm ci
-    - run: npm test
+    - run: bundle exec rake spec
       env:
         CI_CHROME_FLAGS: "--headless"

data/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v*
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
+jobs:
+  push:
+    permissions:
+      contents: write
+      id-token: write
+    if: github.repository == 'ackama/lighthouse-matchers'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@v2
+        with:
+          egress-policy: audit
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+      - uses: rubygems/release-gem@v1

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.0] - 2024-07-13
+### Changed
+- Raise an explict error when the audit category is not found ([#56](https://github.com/ackama/lighthouse-matchers/pull/56))
+- Print run warnings from Lighthouse ([#55](https://github.com/ackama/lighthouse-matchers/pull/55))
+
 ## [1.1.0] - 2023-08-27
 ### Changed
 - Only run audits for categories that are requested to improve performance ([#28](https://github.com/ackama/lighthouse-matchers/pull/28))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lighthouse-matchers (1.1.0)
+    lighthouse-matchers (1.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,7 +14,8 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (2.2.0)
-    rexml (3.2.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -42,6 +43,7 @@ GEM
     rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    strscan (3.1.0)
     unicode-display_width (2.1.0)
     webrick (1.7.0)
 

data/README.md

@@ -121,6 +121,12 @@ for detailed instructions.
 
 This gem endeavours to follow Semantic Versioning 2.0 as defined at https://semver.org/.
 
+## Releasing
+
+Releases are done automatically by GitHub Actions when a new tag is pushed to the repository.
+
+To release a new version, create a pull request updating the "Unreleased" section of `CHANGELOG.md` file to reflect the upcoming version and expected release date, and to update the version number in `lib/lighthouse/matchers/version.rb`. Once the pull request is merged, create a new tag in the format `vX.Y.Z`, which will trigger GitHub Actions to publish the new version to RubyGems.
+
 ## License
 
 lighthouse-matchers is copyright © 2019 Ackama Group Ltd.

data/lib/lighthouse/audit_service.rb

@@ -5,6 +5,8 @@ require 'stringio'
 
 # Compares a url's actual score to the expected score.
 class AuditService
+  class Error < StandardError; end
+
   def initialize(url, audit, score)
     @url = url
     @audit = audit
@@ -20,11 +22,25 @@ class AuditService
   end
 
   def measured_score
-    results.dig('categories', @audit.to_s, 'score') * 100
+    category['score'] * 100
+  end
+
+  def run_warnings
+    results['runWarnings']
   end
 
   private
 
+  def category
+    category = results.dig('categories', @audit.to_s)
+
+    if category.nil?
+      raise Error, "Category '#{@audit}' not found in Lighthouse results - maybe it was removed?"
+    end
+
+    category
+  end
+
   def opts
     "'#{@url}'".tap do |builder|
       builder << ' --quiet'
@@ -40,6 +56,6 @@ class AuditService
   end
 
   def results
-    JSON.parse(output)
+    @results ||= JSON.parse(output)
   end
 end

data/lib/lighthouse/matchers/rspec.rb

@@ -11,6 +11,12 @@ RSpec::Matchers.define :pass_lighthouse_audit do |audit, args = {}|
   match do |target|
     audit_service = AuditService.new(url(target), audit, score)
 
+    audit_service.run_warnings.each do |warning|
+      RSpec.configuration.reporter.message(
+        "#{RSpec.current_example.location}: [lighthouse] #{warning}"
+      )
+    end
+
     @measured_score = audit_service.measured_score
 
     audit_service.passing_score?

data/lib/lighthouse/matchers/version.rb

@@ -2,6 +2,6 @@
 
 module Lighthouse
   module Matchers
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end