lighthouse-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c84dba7f164d2947db4d34b0743b2fa62e251e6552d8170b76ec9f57cd48021e
+  data.tar.gz: bba2e92af4b23e65ae628ef529f901bee480b51cdeabbdcb7b318f2fce3e24e6
+SHA512:
+  metadata.gz: 0133d7c2fa5dca6e292472fe10ed78ac0f25e4e4ce368a01a45ca3a9cd21fbfa0bae830837d49cb1e309b1d7fafa974069d35ed888a648d4852b98a567a6e2ad
+  data.tar.gz: 69eea8a370f6c87b1c49c59f8cedb115793d33458a406c7b52c41d909a4e27ab56233410c118b979468cf11c929c387a946dc1456fdd9415324e2208bd5fe32b

data/.gitignore

@@ -0,0 +1,26 @@
+# Dependencies:
+/.bundle
+/node_modules
+/coverage
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+package-lock.json
+/.yardoc
+/_yardoc/
+/doc
+/pkg
+
+# rspec failure tracking
+.rspec_status
+
+# unrelated folder
+/spec/reports/
+/tmp/
+
+# Editors and IDEs:
+.DS_Store
+.idea/
+.vscode
+*.sw?
+.sublime-workspace

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at budi@teachable.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lighthouse-ruby.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    lighthouse-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  lighthouse-ruby!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Budi Sugianto
+
+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,44 @@
+# Lighthouse::Ruby
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lighthouse/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lighthouse-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lighthouse-ruby
+
+## Usage
+
+TODO: Work in progress
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/UseFedora/lighthouse-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lighthouse-ruby/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lighthouse::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lighthouse-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lighthouse/ruby"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lighthouse/preferences.rb

@@ -0,0 +1,47 @@
+module Lighthouse
+  module Preferences
+    class Error < StandardError; end
+    class << self
+      attr_writer :remote_debugging_port,
+                  :lighthouse_cli,
+                  :runner,
+                  :lighthouse_options,
+                  :chrome_flags
+      attr_reader :remote_debugging_port
+
+      def lighthouse_cli
+        @lighthouse_cli ||= get_lighthouse_cli
+      end
+
+      def runner
+        @runner ||= proc { |cmd| `#{cmd}` }
+      end
+
+      def lighthouse_options
+        return unless @lighthouse_options
+        return @lighthouse_options unless @lighthouse_options.is_a?(Array)
+
+        @lighthouse_options.map { |f| "--#{f}" }.join(' ')
+      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 get_lighthouse_cli
+        system("npm install -g lighthouse") unless File.exist?(lighthouse_bin_locator)
+        lighthouse_bin_locator
+      end
+
+      def lighthouse_bin_locator
+        `which lighthouse`.chomp("\n")
+      end
+
+    end
+  end
+end

data/lib/lighthouse/ruby/builder.rb

@@ -0,0 +1,47 @@
+require "lighthouse/preferences"
+require "json"
+
+module Lighthouse
+  module Ruby
+    class Builder
+
+      def initialize(url)
+        @url = url
+        @runner = Lighthouse::Preferences.runner
+        @cli = Lighthouse::Preferences.lighthouse_cli
+        @port = Lighthouse::Preferences.remote_debugging_port
+        @chrome_flags = Lighthouse::Preferences.chrome_flags
+        @lighthouse_options = Lighthouse::Preferences.lighthouse_options
+      end
+
+      def run_test
+        get_test_scores
+      end
+
+      private
+
+      def options
+        "'#{@url}'".tap do |builder|
+          builder << ' --quiet'
+          builder << ' --output=json'
+          builder << " --port=#{@port}" if @port
+          builder << " --#{@lighthouse_options}" if @lighthouse_options
+          builder << " --chrome-flags='#{@chrome_flags}'" if @chrome_flags
+        end.strip
+      end
+
+      def get_test_scores
+        json_result = JSON.parse(@runner.call("#{@cli} #{options}"))
+
+        @test_scores = { url: @url}
+        @test_scores[:run_time] = Time.now
+        @test_scores[:performance] = json_result.dig("categories", "performance" , "score") * 100
+        @test_scores[:accessibility] = json_result.dig("categories", "accessibility" , "score") * 100
+        @test_scores[:best_practices] = json_result.dig("categories", "best-practices" , "score") * 100
+        @test_scores[:seo] = json_result.dig("categories", "seo" , "score") * 100
+        @test_scores
+      end
+
+    end
+  end
+end

data/lib/lighthouse/ruby/version.rb

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

data/lib/lighthouse/ruby.rb

@@ -0,0 +1,9 @@
+require "lighthouse/ruby/version"
+require "lighthouse/ruby/builder"
+
+module Lighthouse
+  module Ruby
+    class Error < StandardError; end
+
+  end
+end

data/lighthouse-ruby.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/lighthouse/ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lighthouse-ruby"
+  spec.version       = Lighthouse::Ruby::VERSION
+  spec.authors       = ["Budi Sugianto"]
+  spec.email         = ["budi@teachable.com"]
+
+  spec.summary       = <<~DESC
+    Ruby wrapper for lighthouse-cli command by 
+    execute and evaluate for Lighthouse-cli test JSON report
+    ~ inspired from lighthouse-matchers gem by Ackama Group ~
+  DESC
+
+  spec.description   = "Ruby wrapper for lighthouse-cli"
+  spec.homepage      = "https://github.com/UseFedora/lighthouse-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"]    = "https://github.com/UseFedora/lighthouse-ruby"
+  spec.metadata["source_code_uri"] = "https://github.com/UseFedora/lighthouse-ruby"
+  spec.metadata["changelog_uri"]   = "https://github.com/UseFedora/lighthouse-ruby/blob/master/CHANGELOG.md"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: lighthouse-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Budi Sugianto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-13 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: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Ruby wrapper for lighthouse-cli
+email:
+- budi@teachable.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lighthouse/preferences.rb
+- lib/lighthouse/ruby.rb
+- lib/lighthouse/ruby/builder.rb
+- lib/lighthouse/ruby/version.rb
+- lighthouse-ruby.gemspec
+homepage: https://github.com/UseFedora/lighthouse-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/UseFedora/lighthouse-ruby
+  source_code_uri: https://github.com/UseFedora/lighthouse-ruby
+  changelog_uri: https://github.com/UseFedora/lighthouse-ruby/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: 2.3.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: Ruby wrapper for lighthouse-cli command by  execute and evaluate for Lighthouse-cli
+  test JSON report ~ inspired from lighthouse-matchers gem by Ackama Group ~
+test_files: []