lighthouse-matchers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f51726040b980a9839d9d977ed5c4d33970143487d99e45a232b14ed1285f676
+  data.tar.gz: 76d4e7ebca933f34aca2493b3a7b2835f3ad40eb2e7e85c9941edf34cd612556
+SHA512:
+  metadata.gz: bf67b535c041abfd96e076e785b427591c0a6deed1b0c0143ba59ef3925d6ee0da5c2908482fe09ecc2509c1d13b77c8e919da1d394305868dadf59cfe969e91
+  data.tar.gz: fd2c2314d4c48911b64b664580a71b26c7296af56053dba9c904bb68f6406039acaa8d98bc7870c77dc428c36a58ee30c062c2a9ec062de0745e4f75eca06a89

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/BlockLength:
+  Exclude: 
+    - 'spec/**/*_spec.rb'
+    - 'lighthouse-matchers.gemspec'
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+cache: bundler
+before_install:
+  - gem update --system --no-document
+  - gem install bundler --no-document
+install: "bin/setup"
+script: "bin/ci-run"

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lighthouse-matchers.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    lighthouse-matchers (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.70.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  lighthouse-matchers!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Ackama
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# Lighthouse Matchers [![Maintainability](https://api.codeclimate.com/v1/badges/2f1df198307f6a0489fc/maintainability)](https://codeclimate.com/github/ackama/lighthouse-matchers/maintainability) [![Build Status](https://travis-ci.org/ackama/lighthouse-matchers.svg?branch=master)](https://travis-ci.org/ackama/lighthouse-matchers)
+
+Lighthouse Matchers provides single-line RSpec matchers for 
+expectations against the result of [Lighthouse](https://developers.google.com/web/tools/lighthouse/) 
+audit checks.
+
+## Getting Started
+
+### RSpec
+
+Start by including the gem in your Gemfile:
+
+``` ruby
+group :test do
+  gem 'lighthouse-matchers'
+end
+```
+
+Next, you need to require the matchers in your `spec_helper.rb` or `rails_helper.rb`:
+
+``` ruby
+require "lighthouse/matchers/rspec"
+```
+
+You also need to have the `lighthouse` CLI tool available. The matchers will automatically pick up the tool
+if you have added it to your `$PATH`, or if you have installed the tool using: 
+
+* `npm install --save-dev lighthouse` 
+* `yarn add --dev ligththouse`
+
+If you have the `lighthouse` CLI tool installed, but available elsewhere on your system, you can set the location manually.
+See [Configuration](#configuration) for further instructions.
+
+The matchers are now available to use. If you wish for your Lighthouse audits to use the same Chrome session
+as your system tests (e.g. the page requires a logged-in user), then you should 
+change the definition of your system test Chrome browser arguments to define a "remote debugging port". Without
+defining this port, The `lighthouse` audit tool cannot connect to your existing Chrome session and will begin a new
+one, clearing any session information.
+
+An example of such a configuration is:
+
+``` ruby
+# spec/spec_helper.rb
+
+Capybara.register_driver :headless_chrome do |app|
+  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
+    chromeOptions: { args: %w(headless remote-debugging-port=9222) }
+  )
+
+  Capybara::Selenium::Driver.new app,
+    browser: :chrome,
+    desired_capabilities: capabilities
+end
+
+Capybara.javascript_driver = :headless_chrome
+Lighthouse::Matchers.remote_debugging_port = 9222
+```
+
+### Test::Unit
+
+Test::Unit support is planning and is coming soon!
+
+## Matchers
+
+### `pass_lighthouse_audit` 
+
+This matcher accepts an optional audit type, and minimum score. 
+If no audit type is passed in, then all audits are run. If a minimum score is not provided, then the score defined 
+in `Lighthouse::Matchers.minimum_score` is used. The default value of this attribute is 100 - i.e. the audit must pass 
+entirely.
+
+#### Examples
+
+* Assert that a URL fully passes all audits:
+  ```
+  it { expect("http://mysite.com").to pass_lighthouse_audit }
+  ```
+* Assert that a Capybara page object passes a performance audit only:
+  ```
+  it { expect(page).to pass_lighthouse_audit(:performance) }
+  ```
+* Assert that a Capybara page object passes all audits with a minimum score of 60:
+  ``` 
+  it { expect(page).to pass_lighthouse_audit(score: 60) }
+  ```
+* Assert that a URL passes the PWA audit with a minimum score of 90:
+  ```
+  it { expect("http://pwa.mysite.com").to pass_lighthouse_audit(:pwa, score: 90) }
+  ```
+
+## Configuration
+
+All configuration keys are accessible against the `Lighthouse::Matchers` object. Configuration options include:
+
+* **`remote_debugging_port`:** If defined, Lighthouse will connect to this Chrome debugging port. 
+  This allows the audit to run in the same context as the Chrome session that created the port 
+  (for example, in Capybara, this would be the current state of the page under test). This setting is useful for 
+  running a Lighthouse audit against the _current state_ of a page, rather than it's initial load state. This setting
+  must match up with the remote debugging port that has been configured for the Chrome browser instance if 
+  Selenium webdrivers are being used.
+* **`lighthouse_cli`:** The path to the Lighthouse CLI tool. By default, we will check `$PATH` and `node_modules/.bin/`
+  for the CLI. This setting can be used if the Lighthouse tool is installed in a non-standard location.
+* **`minimum_score`:** The default minimum score that audits must meet for the matcher to pass. 
+  The default value of this configuration setting is '100' - e.g. audits must fully comply to pass.
+
+## Compatibility
+
+* Lighthouse Matchers is tested and supported against Ruby 2.0+ and RSpec 3.x. 
+* The `lighthouse` CLI tool must be installed for these matchers to function.
+* The [`capybara`](https://rubygems.org/gems/capybara) gem is required to make assertions 
+  by passing in a `Capybara::Session`.
+
+## Contributing
+
+Contributions are welcome. 
+Please see the [contribution guidelines](https://github.com/ackama/lighthouse-matchers/blob/master/CONTRIBUTING.md) 
+for detailed instructions.
+
+## Versioning
+
+This gem endeavours to follow Semantic Versioning 2.0 as defined at https://semver.org/.
+
+## License
+
+lighthouse-matchers is copyright © 2019 Ackama Group Ltd.
+It is free software, and may be redistributed under the terms specified in the 
+[LICENSE](https://github.com/ackama/lighthouse-matchers/blob/master/LICENSE.txt) file.
+
+
+## About Ackama
+
+Lighthouse Matchers is created and maintained by Ackama Group using our investment time scheme. 
+We are passionate about using and contributing back to the open source community, and are available for hire.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/ci-run

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+bundle exec rspec spec
+bundle exec rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lighthouse/audit/matchers'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/lighthouse/matchers/rspec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+require 'lighthouse/matchers'
+require 'json'
+
+RSpec::Matchers.define :pass_lighthouse_audit do |audit, score: nil|
+  match do |target|
+    score ||= Lighthouse::Matchers.minimum_score
+    port = Lighthouse::Matchers.remote_debugging_port
+    runner = Lighthouse::Matchers.runner
+
+    url = target.respond_to?(:current_url) ? target.current_url : target
+    opts = "'#{url}' --quiet --output=json"
+    opts << " --port '#{port}'" if port
+    cmd = Lighthouse::Matchers.lighthouse_cli
+    output = runner.call("#{cmd} #{opts}")
+    results = JSON.parse(output)
+    actual_score = results.dig('categories', audit.to_s, 'score') * 100
+    actual_score >= score
+  end
+
+  failure_message do |target|
+    url = target.respond_to?(:current_url) ? target.current_url : target
+    <<~FAIL
+      expected #{url} to pass Lighthouse #{audit} audit
+      with a minimum score of #{score}
+    FAIL
+  end
+end

data/lib/lighthouse/matchers/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lighthouse
+  module Matchers
+    VERSION = '1.0.0'
+  end
+end

data/lib/lighthouse/matchers.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'lighthouse/matchers/version'
+
+module Lighthouse
+  ##
+  # Defines configuration and behaviours that are shared across the entire
+  # Lighthouse::Matchers namespace
+  module Matchers
+    class Error < StandardError; end
+    class << self
+      attr_writer :minimum_score,
+                  :remote_debugging_port,
+                  :lighthouse_cli,
+                  :runner
+      attr_reader :remote_debugging_port
+
+      def minimum_score
+        @minimum_score ||= default_minimum_score
+      end
+
+      def lighthouse_cli
+        @lighthouse_cli ||= lighthouse_cli
+      end
+
+      def runner
+        @runner ||= Kernel.method(:system)
+      end
+
+      private
+
+      def guess_lighthouse_cli
+        [
+          `which lighthouse` || '',
+          'node_modules/.bin/lighthouse',
+          'node_modules/bin/lighthouse'
+        ].find { |loc| File.exist?(loc) }
+      end
+
+      def default_minimum_score
+        100
+      end
+    end
+  end
+end

data/lighthouse-matchers.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lighthouse/matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lighthouse-matchers'
+  spec.version       = Lighthouse::Matchers::VERSION
+  spec.authors       = ['Josh McArthur on behalf of Ackama']
+  spec.email         = ['josh.mcarthur@ackama.com']
+
+  spec.summary       = <<~DESC
+    Provides RSpec matchers for executing and evaluating Lighthouse audit scores
+  DESC
+  spec.homepage = 'https://github.com/ackama/lighthouse-matchers'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/ackama/lighthouse-matchers'
+    spec.metadata['changelog_uri'] = 'https://github.com/ackama/lighthouse-matchers/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: lighthouse-matchers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Josh McArthur on behalf of Ackama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: 
+email:
+- josh.mcarthur@ackama.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/ci-run
+- bin/console
+- bin/setup
+- lib/lighthouse/matchers.rb
+- lib/lighthouse/matchers/rspec.rb
+- lib/lighthouse/matchers/version.rb
+- lighthouse-matchers.gemspec
+homepage: https://github.com/ackama/lighthouse-matchers
+licenses: []
+metadata:
+  homepage_uri: https://github.com/ackama/lighthouse-matchers
+  source_code_uri: https://github.com/ackama/lighthouse-matchers
+  changelog_uri: https://github.com/ackama/lighthouse-matchers/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides RSpec matchers for executing and evaluating Lighthouse audit scores
+test_files: []