lighthouse-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c84dba7f164d2947db4d34b0743b2fa62e251e6552d8170b76ec9f57cd48021e
-  data.tar.gz: bba2e92af4b23e65ae628ef529f901bee480b51cdeabbdcb7b318f2fce3e24e6
+  metadata.gz: 9e7b870fb6324f0497790a8e4a5b5924e1340aaa4d33465f114e5dfe4d499b44
+  data.tar.gz: 744b5ed24dae228555193ecf6e0a0f36de24f3d33665e75549f33e657fcc89a4
 SHA512:
-  metadata.gz: 0133d7c2fa5dca6e292472fe10ed78ac0f25e4e4ce368a01a45ca3a9cd21fbfa0bae830837d49cb1e309b1d7fafa974069d35ed888a648d4852b98a567a6e2ad
-  data.tar.gz: 69eea8a370f6c87b1c49c59f8cedb115793d33458a406c7b52c41d909a4e27ab56233410c118b979468cf11c929c387a946dc1456fdd9415324e2208bd5fe32b
+  metadata.gz: 284a6301e0f4f28eac94f8ede197aaaba6e367282edf5eaaa99c2d35b038fe1f991ccc5a4e6b1aed03d3388cf61e962de11436b97d8df6a826a2392cbee8cb20
+  data.tar.gz: 7646a486ae91c4a7a878558e18160af35b226a586e4d6f1e26b791e7d023e06daf830bd6cfda36955ccaf0a43e0957c46f222bc3030b953db62f93630fba1d85

data/README.md

@@ -9,7 +9,9 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lighthouse-ruby'
+group :test do
+  gem 'lighthouse-ruby'
+end
 ```
 
 And then execute:
@@ -20,15 +22,80 @@ Or install it yourself as:
 
     $ gem install lighthouse-ruby
 
-## Usage
+Another dependency you also need to have the `lighthouse` CLI tool available. The gem will automatically pick up the tool
+if `lighthouse` already installed, or if there are no executable lighthouse file then it will automatically install for you.
+Additionally if you want install it manually and added to dev dependency on the`package.sjon`, feel free to use any of this commands:
+                   
+* `npm install --save-dev lighthouse` 
+* `yarn add --dev lighthouse`
 
-TODO: Work in progress
+If you have the `lighthouse` CLI tool installed, but available somewhere on your system, you can set the location manually.
+See [Configuration](#configuration) for further instructions.
 
-## Development
+## Usage
+After all the installation, now the `lighthouse\ruby` can be imported by adding this code to your test helper.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+ require "lighthouse/ruby"
+``` 
+The idea to have this inside your test framework without adding too much overhead and un-necessary code in order to use 
+the same Chrome session as your system test framework (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/ruby` cannot connect to your existing Chrome session and will begin a new
+one, clearing any session information.
+
+## Setup Code
+```
+Capybara.register_driver :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 = :chrome
+Lighthouse::Matchers.remote_debugging_port = 9222
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### For Rspec
+Place the configuration on `spec/spec_helper.rb` or `spec/rails_helper.rb`
+ 
+#### For Cucumber
+Place the configuration on `features/env.rb` or where the Capybara and Chromedriver defined. 
+
+## Configuration
+There are several additional configuration that accessible and align with official `lighthouse-cli`. 
+All the additional options:
+* **`remote_debugging_port`:** If defined, Lighthouse will connect to this Chrome debugging port. 
+  This allows the test to run in the same session as the Chrome session that created the port 
+  (in th case of Capybara, this will be the same _current_state_ of `page` or `Capybara::Session` under test) 
+  by match up the remote debugging port that has been configured for the Chrome browser instance. 
+* **`lighthouse_path`:** The path to the Lighthouse CLI tool. By default, it will check `/usr/bin/`, `/usr/local/bin` 
+  and `node_modules/.bin/` for the CLI. Therefor when the gem cannot find any executable file do not panic because
+  it will install the latest `lighthouse` from npm globally.
+* **`chrome_flags`:** Any additional flags that should be passed to Chrome when Lighthouse launches a browser instance. 
+  As an example, running Lighthouse in Docker container or CI environment might requires the headless Chrome flags 
+  (`--headless`, `--no-sandbox`) in order Chrome to successfully start. Chrome flags can be either specified as an array
+  or string.(eq: `["headless", "no-sandbox"]` or `"headless", "no-sandbox"`). 
+* **`lighthouse_options`:** Any additional options that can be passed to Lighthouse CLI. All the options can be found by 
+  running `lighthouse --help` in the terminal or go this [link](https://github.com/GoogleChrome/lighthouse#cli-options) for more details. For an example usage, running Lighthouse in different emulated form factor 
+  such as: a mobile, or desktop use `emulated-form-factor=<type>`. Another usage by adding additional headers during the 
+  erequest simply add `--extra-headers`. Also, Lighthouse options can either be specified as an array or string. 
+  (eq: `["emulated-form-factor=desktop", "--extra-headers '{\"food\":\"burger\", \"drink\":\"coke\"}'"]` or `"emulated-form-factor=desktop", "--extra-headers '{\"food\":\"burger\", \"drink\":\"coke\"}'"`). 
+
+## Run Test
+How to get the test report simply create object for `lighthouse-ruby` with url that need to be tested.
+For `Capybara::Session` then `current_url` is the URL that you want to access.
+```
+ report = Lighthouse::Ruby::Builder.new(current_url)
+ report.execute  # => will get all JSON object
+ report.test_scores  # => Will get only meaningful hash of scores such as: performance, accessibility, best-practices, and SEO 
+ => {:url=>"http://test.example.com:3001/", :run_time=>2020-05-14 13:10:12 +0000, :performance=>100, :accessibility=>80.0, :best_practices=>77.0, :seo=>90.0} 
+```  
+To be more flexible `report.execute` will return the JSON report and it should be easily parse into Ruby Hash as needed.
 
 ## Contributing
 

data/lib/lighthouse/ruby/builder.rb

@@ -14,8 +14,12 @@ module Lighthouse
         @lighthouse_options = Lighthouse::Preferences.lighthouse_options
       end
 
-      def run_test
-        get_test_scores
+      def execute
+        @response = @runner.call("#{@cli} #{options}")
+      end
+
+      def test_scores
+        get_test_scores(@response)
       end
 
       private
@@ -30,9 +34,8 @@ module Lighthouse
         end.strip
       end
 
-      def get_test_scores
-        json_result = JSON.parse(@runner.call("#{@cli} #{options}"))
-
+      def get_test_scores(response)
+        json_result = JSON.parse(response)
         @test_scores = { url: @url}
         @test_scores[:run_time] = Time.now
         @test_scores[:performance] = json_result.dig("categories", "performance" , "score") * 100

data/lib/lighthouse/ruby/version.rb

@@ -1,5 +1,5 @@
 module Lighthouse
   module Ruby
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lighthouse-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Budi Sugianto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler