lighthouse-matchers 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39bae0e8641dae16dd253b900d90ccf0e96008353bebff86bacfc7007d4131ca
-  data.tar.gz: 5ec2143cae768123fe66d882800513e1cf4d2e6194d74bb9297fde83bab999f7
+  metadata.gz: 4875808814d5062e018b2b97ca213d4970410e17d8815384faecf8515d7c3a54
+  data.tar.gz: 0c5987ca693dfb3fcf082ee4ae66453094b5c3a9421d72a6ee91b25b65d9767c
 SHA512:
-  metadata.gz: e537f89cf5cb908ec7f4afe6ddfce0cdca25ac710ac7e8ee7365a53630e8b854ba9155f33c1e9c37ed59eae19d62e6194198715ad466f7268b5dd3e45ec66d36
-  data.tar.gz: d9ce149527bf757d862d93baf1a1fdc3a5b60064c73d50d5304f5c5ffa36edde525b00a38ce6dc3c96c7516240e8e6b7a7c55a1ec4381a05275dde330da7b346
+  metadata.gz: 111ac3364c7917956c736fea0dd651df06219a4aef9ab5f7a9390bfa2a3707389aab6f53328da636f08909e545fbe520b5e3b55454d2fe07d441a5f9167f611c
+  data.tar.gz: 2b9dc90ee947fa25ab8c7103da174b068d893693a49496dd5d0fb7c946fcdc17413e7a6f99f08e29cbf3fefc430f157a902c946a14eb7dd5049a633f1178568e

data/CHANGELOG.md

@@ -18,4 +18,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Refactored auditing into a service object (@CaraHill)
 -
+## [1.0.3] - 2019-08-27
+### Added
+
+- **chrome_flags** option to allow the Chrome launch behaviour of the `lighthouse` command. (#8)
+
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lighthouse-matchers (1.0.2)
+    lighthouse-matchers (1.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -26,7 +26,7 @@ You also need to have the `lighthouse` CLI tool available. The matchers will aut
 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`
+* `yarn add --dev lighthouse`
 
 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.
@@ -102,6 +102,7 @@ All configuration keys are accessible against the `Lighthouse::Matchers` object.
   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.
+* **`chrome_flags`:** Any additional flags that should be passed to Chrome when Lighthouse launches a browser instance. As an example, running Lighthouse in Docker requires the normal headless Chrome flags (`--headless`, `--no-sandbox`) for Chrome to successfully start. Chrome flags can either be specified as an array (`["headless", "no-sandbox"]`) or as a string (`--headless --no-sandbox`).
 
 ## Compatibility
 
@@ -130,4 +131,4 @@ It is free software, and may be redistributed under the terms specified in the
 ## 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.
+We are passionate about using and contributing back to the open source community, and are available for hire.

data/lib/lighthouse/audit_service.rb

@@ -1,6 +1,7 @@
-# frozen_string_literal: true
+# frozen_string_literal: false
 
 require 'json'
+require 'stringio'
 
 # Compares a url's actual score to the expected score.
 class AuditService
@@ -11,6 +12,7 @@ class AuditService
     @port = Lighthouse::Matchers.remote_debugging_port
     @runner = Lighthouse::Matchers.runner
     @cmd = Lighthouse::Matchers.lighthouse_cli
+    @chrome_flags = Lighthouse::Matchers.chrome_flags
   end
 
   def passing_score?
@@ -20,7 +22,12 @@ class AuditService
   private
 
   def opts
-    "'#{@url}' --quiet --output=json #{"--port=#{@port}" if @port}".strip
+    "'#{@url}'".tap do |builder|
+      builder << ' --quiet'
+      builder << ' --output=json'
+      builder << " --port=#{@port}" if @port
+      builder << " --chrome-flags='#{@chrome_flags}'" if @chrome_flags
+    end.strip
   end
 
   def output

data/lib/lighthouse/matchers.rb

@@ -2,17 +2,18 @@
 
 require 'lighthouse/matchers/version'
 
+##
+# Defines configuration and behaviours that are shared across the entire
+# Lighthouse::Matchers namespace
 module Lighthouse
-  ##
-  # Defines configuration and behaviours that are shared across the entire
-  # Lighthouse::Matchers namespace
-  module Matchers
+  module Matchers # rubocop:disable Style/Documentation
     class Error < StandardError; end
     class << self
       attr_writer :minimum_score,
                   :remote_debugging_port,
                   :lighthouse_cli,
-                  :runner
+                  :runner,
+                  :chrome_flags
       attr_reader :remote_debugging_port
 
       def minimum_score
@@ -27,6 +28,13 @@ module Lighthouse
         @runner ||= proc { |cmd| `#{cmd}` }
       end
 
+      def chrome_flags
+        return unless @chrome_flags
+        return @chrome_flags unless @chrome_flags.is_a?(Array)
+
+        @chrome_flags.map { |f| "--#{f}" }.join(' ')
+      end
+
       private
 
       def guess_lighthouse_cli

data/lib/lighthouse/matchers/version.rb

@@ -2,6 +2,6 @@
 
 module Lighthouse
   module Matchers
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lighthouse-matchers
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Josh McArthur on behalf of Ackama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler