standout-capybara 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6950cf22eb3d1e45eecf589e318c44b191c3d4c93797a433313dd4bc6722821f
+  data.tar.gz: 37dcac1e6d09906a048af2bf808afc4f245fb324d6f89e00d75fb895b2549908
+SHA512:
+  metadata.gz: 68e155be9d9027b5cb2b587202f4cc2764dafc688fbe7bba075d263fca7145337708b848b4a0914f708615a39e0791fd4201183feb98b57cd37aa9765e3e2ea2
+  data.tar.gz: 4417731c817dba3f3fa09ee4e33ee10a1aa94bb800411ba06e47aad7b795a1565d9fe02ad16d3714038151469e5d890eccfa6dc80b88d89239c53d3d951068fc

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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.1

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 alex@aross.se. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in standout-capybara.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    standout-capybara (0.1.0)
+      capybara
+      capybara-screenshot
+      chromedriver-helper
+      selenium-webdriver
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    archive-zip (0.11.0)
+      io-like (~> 0.3.0)
+    capybara (3.11.1)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.2)
+      xpath (~> 3.2)
+    capybara-screenshot (1.0.22)
+      capybara (>= 1.0, < 4)
+      launchy
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    chromedriver-helper (2.1.0)
+      archive-zip (~> 0.10)
+      nokogiri (~> 1.8)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    io-like (0.3.0)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    regexp_parser (1.3.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.2)
+      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)
+    rubyzip (1.2.2)
+    selenium-webdriver (3.141.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2, >= 1.2.2)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  standout-capybara!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexander Ross
+
+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,91 @@
+# Standout Capybara
+
+The purpose of this gem is to make it easier to setup Capybara drivers with sane defaults. It will default to `headless_chrome`, and if you use it with nanobox it will default to `nanobox_chrome`. But feel free to overwrite the environment variable CAPYBARA to use another capybara driver.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+group :development, :test do
+  gem "capybara"
+  gem "standout-capybara", require: false
+end
+
+# test_helper.rb, spec_helper.rb or rails_helper.rb etc
+require 'capybara/rails'
+require 'standout/capybara/setup'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Headless chrome
+
+Just run your test command, the `headless_chrome` is the default driver
+
+
+### Chrome
+
+Run the test command with `CAPYBARA=chrome`.
+
+Example:
+
+```bash
+$ CAPYBARA=chrome rake
+```
+
+### Nanobox chrome
+
+Add a local only component of standalone chrome to your `boxfile.yml`
+
+```yml
+data.chrome:
+  image: selenium/standalone-chrome
+  local_only: true
+```
+
+Now you can run the test as usual.
+
+Example:
+
+```bash
+$ nanobox run rake
+```
+
+### Available drivers
+
+Override the driver using the environment variable `CAPYBARA`.
+
+Example:
+
+```bash
+CAPYBARA=[driver name] test-command
+```
+
+| Driver name      | Description |
+|:-----------------|:------------|
+| chrome           | Regular chrome driver that will use a visual browser window. |
+| headless_chrome  | Headless chrome driver. The default driver. |
+| nanobox_chrome  | Default driver when inside Nanobox. |
+## 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/[USERNAME]/standout-capybara. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Standout::Capybara project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/standout-capybara/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 "standout/capybara"
+
+# 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/standout/capybara/drivers/base.rb

@@ -0,0 +1,26 @@
+module Standout
+  module Capybara
+    module Drivers
+      class Base
+        def self.use!
+          ::Capybara.javascript_driver = driver_name
+          ::Capybara.default_driver = driver_name
+        end
+
+        def self.register
+          ::Capybara::Screenshot.register_driver(driver_name) do |driver, path|
+            driver.browser.save_screenshot(path)
+          end
+        end
+
+        def self.driver_name=(value)
+          @driver_name = value
+        end
+
+        def self.driver_name
+          @driver_name
+        end
+      end
+    end
+  end
+end

data/lib/standout/capybara/drivers/chrome.rb

@@ -0,0 +1,21 @@
+module Standout
+  module Capybara
+    module Drivers
+      class Chrome < Standout::Capybara::Drivers::Base
+        self.driver_name = :chrome
+
+        def self.register
+          ::Capybara.register_driver driver_name do |driver|
+            options = Selenium::WebDriver::Chrome::Options.new
+            options.args << "window-size=1920,1024"
+
+            ::Capybara::Selenium::Driver.new(driver,
+                                             browser: :chrome,
+                                             options: options)
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/standout/capybara/drivers/headless_chrome.rb

@@ -0,0 +1,23 @@
+module Standout
+  module Capybara
+    module Drivers
+      class HeadlessChrome < Standout::Capybara::Drivers::Base
+        self.driver_name = :headless_chrome
+
+        def self.register
+          ::Capybara.register_driver driver_name do |driver|
+            options = Selenium::WebDriver::Chrome::Options.new
+            options.args << "window-size=1920,1024"
+            options.args << "disable-gpu"
+            options.args << "headless"
+
+            ::Capybara::Selenium::Driver.new(driver,
+                                             browser: :chrome,
+                                             options: options)
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/standout/capybara/drivers/nanobox_chrome.rb

@@ -0,0 +1,25 @@
+module Standout
+  module Capybara
+    module Drivers
+      class NanoboxChrome < Standout::Capybara::Drivers::Base
+        self.driver_name = :nanobox_chrome
+
+        def self.use!
+          ::Capybara.server_host = ENV["HOSTNAME"] if ENV["HOSTNAME"]&.empty?
+          super
+        end
+
+        def self.register
+          ::Capybara.register_driver driver_name do |driver|
+            chrome_host = ENV["CHROME_HOST"] || ENV["DATA_CHROME_HOST"]
+            ::Capybara::Selenium::Driver.new(driver,
+                                           browser: :remote,
+                                           desired_capabilities: :chrome,
+                                           url: "http://#{chrome_host}:4444/wd/hub")
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/standout/capybara/setup.rb

@@ -0,0 +1,3 @@
+require "standout/capybara"
+
+Standout::Capybara.setup_driver

data/lib/standout/capybara/version.rb

@@ -0,0 +1,5 @@
+module Standout
+  module Capybara
+    VERSION = "1.0.0"
+  end
+end

data/lib/standout/capybara.rb

@@ -0,0 +1,41 @@
+require "standout/capybara/version"
+require "capybara"
+require "capybara-screenshot"
+require "selenium-webdriver"
+require "chromedriver-helper"
+require "standout/capybara/drivers/base"
+require "standout/capybara/drivers/chrome"
+require "standout/capybara/drivers/nanobox_chrome"
+require "standout/capybara/drivers/headless_chrome"
+
+module Standout
+  module Capybara
+    def self.setup_driver
+      driver_name = ENV["CAPYBARA"]
+      is_using_nanobox = `whoami`.chomp == "gonano"
+      fallback_driver = is_using_nanobox ? :nanobox_chrome : :headless_chrome
+      driver_name ||= fallback_driver
+      driver_name = driver_name.to_sym
+
+      case driver_name
+      when :chrome
+        Standout::Capybara::Drivers::Chrome.register
+        Standout::Capybara::Drivers::Chrome.use!
+      when :nanobox_chrome
+        Standout::Capybara::Drivers::NanoboxChrome.register
+        Standout::Capybara::Drivers::NanoboxChrome.use!
+      else
+        Standout::Capybara::Drivers::HeadlessChrome.register
+        Standout::Capybara::Drivers::HeadlessChrome.use!
+      end
+
+      if ::Capybara.respond_to? :default_max_wait_time
+        ::Capybara.default_max_wait_time = 30
+      else
+        ::Capybara.default_wait_time = 30
+      end
+    end
+
+    class Error < StandardError; end
+  end
+end

data/standout-capybara.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "standout/capybara/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "standout-capybara"
+  spec.version       = Standout::Capybara::VERSION
+  spec.authors       = ["Standout AB"]
+  spec.email         = ["standout-capybara-gem@standout.se"]
+
+  spec.summary       = %q{Sane defaults for capybara}
+  spec.homepage      = "https://github.com/standout/standout-capybara"
+  spec.license       = "MIT"
+
+  # 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_dependency "capybara"
+  spec.add_dependency "capybara-screenshot"
+  spec.add_dependency "selenium-webdriver"
+  spec.add_dependency "chromedriver-helper"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: standout-capybara
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Standout AB
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+description: 
+email:
+- standout-capybara-gem@standout.se
+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/standout/capybara.rb
+- lib/standout/capybara/drivers/base.rb
+- lib/standout/capybara/drivers/chrome.rb
+- lib/standout/capybara/drivers/headless_chrome.rb
+- lib/standout/capybara/drivers/nanobox_chrome.rb
+- lib/standout/capybara/setup.rb
+- lib/standout/capybara/version.rb
+- standout-capybara.gemspec
+homepage: https://github.com/standout/standout-capybara
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Sane defaults for capybara
+test_files: []