wayfarer 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b5aceb6e67a298f9ddc3bffecf24446b2e95850e2bfe31f0d245fbb8a4e17f0
-  data.tar.gz: db7323a6cb7942319478753d3060b54cdc7551c3ac6fb0c32bf49015d6f29c68
+  metadata.gz: 98db45c7ede4e4949b4a18c5560477a64982e78f6640e388de2809b5cab02a27
+  data.tar.gz: dc69bf066254600c4b9021234bf4623edd039c87d5cb79166bb7ef174ebe644b
 SHA512:
-  metadata.gz: 016a9d535cf7a3c02afc1bb2503d701328cb6ac55e8c8bdfdeda782c6c8d2eab8528ef30c1b05e4241b8f439f98617865b7d00ff7fd6b49683d288d431e37936
-  data.tar.gz: 748d79ed7028e114dc2aff3cb1d31b4163bc7ff289ea9f20f78bec4c5941622ecf40e58330e7e5c678884f37cbb800b8bd2acb8aca106916e8daccc510567e85
+  metadata.gz: cc001901a22a9d9a84aa16b3946cbc7e0954db1b20a16d3c105411039273138c15ffa60bec57503aa4b73c39b39fde78ad7600697a3f461620316ed05583e91d
+  data.tar.gz: 0be5255180603e2e9d7171aec9f54008b21e1e4ebf6c3e7069535a9d01d59e620aef4c171a84b5d46a754e45043f1ec95c2672847fc03231cff880a3796e48cf

data/.github/workflows/lint.yaml

@@ -0,0 +1,25 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - '*'
+env:
+  CI: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Start services
+        run: docker-compose up -d wayfarer
+
+      - name: RuboCop
+        if: success() || failure()
+        run: docker-compose run --rm --name test wayfarer bundle exec rake lint:rubocop
+
+      - name: Vale
+        if: success() || failure()
+        run: docker-compose run --rm --name test wayfarer bundle exec rake lint:vale

data/.github/workflows/release.yaml

@@ -0,0 +1,29 @@
+name: release
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - run: docker compose up -d
+
+      - run: docker compose exec -T wayfarer git config --global --add safe.directory /opt/app
+
+      - name: Release gem
+        env:
+          GIT_AUTHOR_NAME: Dominic Bauer
+          GIT_AUTHOR_EMAIL: bauerd@users.noreply.github.com
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+        run: |
+          docker compose exec -T \
+          -e GEM_HOST_API_KEY="${{ env.GEM_HOST_API_KEY }}" \
+          -e GIT_AUTHOR_NAME="${{ env.GIT_AUTHOR_NAME }}" \
+          -e GIT_AUTHOR_EMAIL="${{ env.GIT_AUTHOR_EMAIL }}" \
+          -e GIT_COMMITTER_NAME="${{ env.GIT_AUTHOR_NAME }}" \
+          -e GIT_COMMITTER_EMAIL="${{ env.GIT_AUTHOR_EMAIL }}" \
+          wayfarer bundle exec rake release

data/.github/workflows/tests.yaml

@@ -0,0 +1,30 @@
+name: tests
+
+on:
+  push:
+    branches: ["*"]
+
+env:
+  CI: true
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Docker Compose
+        run: docker-compose up -d
+
+      - name: Isolated tests
+        run: docker-compose exec -T wayfarer bundle exec rake test:isolated
+
+      - name: Ferrum tests
+        run: docker-compose exec -T wayfarer bundle exec rake test:ferrum
+
+      - name: Selenium tests
+        run: docker-compose exec -T wayfarer bundle exec rake test:selenium
+
+      - name: CLI tests
+        run: docker-compose exec -T wayfarer bundle exec rake test:cli

data/.gitignore

@@ -2,6 +2,10 @@
 .bundle
 .yardoc
 *.gem
+dump.rdb
 build
 yard
+vale
 \#*#
+.tool-versions
+*.tar.gz

data/.rubocop.yml

@@ -27,12 +27,16 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
 Metrics/MethodLength:
   Max: 20
 
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*"
+    - "**/*.rake"
 
 Metrics/AbcSize:
   Max: 30
@@ -45,3 +49,4 @@ Metrics/CyclomaticComplexity:
 Lint/ConstantDefinitionInBlock:
   Exclude:
     - "spec/**/*"
+

data/.vale.ini

@@ -0,0 +1,5 @@
+StylesPath = .github/share/vale
+MinAlertLevel = suggestion
+
+[*.md]
+BasedOnStyles = Google

data/.yardopts

@@ -1,3 +1 @@
---output-dir yard
---markup markdown
---protected
+--output-dir yard --markup markdown

data/Dockerfile

@@ -1,5 +1,6 @@
-FROM ruby:2.7.4
-ENV CI=true
-WORKDIR /usr/src/app
-COPY . .
+FROM ruby:2.7.7-alpine
+RUN apk add --no-cache git build-base
+WORKDIR /opt/app
+COPY Gemfile Gemfile.lock *.gemspec ./
 RUN bundle install
+COPY . .

data/Gemfile

@@ -3,3 +3,6 @@
 source "https://rubygems.org"
 
 gemspec name: "wayfarer"
+
+gem "rerun"
+gem "yard"

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    wayfarer (0.4.6)
-      activejob (>= 6.0)
+    wayfarer (0.4.7)
+      activejob (>= 7.1)
       addressable (~> 2.8)
       capybara (~> 3.0)
       connection_pool (~> 2.2)
@@ -18,23 +18,30 @@ PATH
       redis (~> 4.4, < 4.5)
       selenium-webdriver (~> 3.4)
       thor (~> 1.0)
+      zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (6.1.4.1)
-      activesupport (= 6.1.4.1)
+    activejob (7.1.3.1)
+      activesupport (= 7.1.3.1)
       globalid (>= 0.3.6)
-    activesupport (6.1.4.1)
+    activesupport (7.1.3.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    capybara (3.36.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    capybara (3.39.2)
       addressable
       matrix
       mini_mime (>= 0.1.3)
@@ -44,127 +51,125 @@ GEM
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
     childprocess (3.0.0)
-    cliver (0.3.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    connection_pool (2.2.5)
-    cuprite (0.13)
-      capybara (>= 2.1, < 4)
-      ferrum (~> 0.11.0)
-    diff-lcs (1.4.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    cuprite (0.15)
+      capybara (~> 3.0)
+      ferrum (~> 0.14.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    factory_bot (6.2.0)
+    domain_name (0.6.20240107)
+    drb (2.2.0)
+      ruby2_keywords
+    factory_bot (6.4.5)
       activesupport (>= 5.0.0)
     faker (1.9.6)
       i18n (>= 0.7)
-    faraday (1.9.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-cookie_jar (0.0.7)
       faraday (>= 0.8.0)
       http-cookie (~> 1.0.0)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
     faraday-encoding (0.0.5)
       faraday
-    faraday-excon (1.1.0)
-    faraday-http-cache (2.2.0)
+    faraday-follow_redirects (0.3.0)
+      faraday (>= 1, < 3)
+    faraday-gzip (1.0.0)
+      faraday (>= 1.0)
+      zlib (~> 2.1)
+    faraday-http-cache (2.5.1)
       faraday (>= 0.8)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
-    fastimage (2.2.6)
-    ferrum (0.11)
+    faraday-net_http (3.0.2)
+    faraday-retry (2.2.1)
+      faraday (~> 2.0)
+    fastimage (2.3.1)
+    ferrum (0.14)
       addressable (~> 2.5)
-      cliver (~> 0.3)
       concurrent-ruby (~> 1.1)
+      webrick (~> 1.7)
       websocket-driver (>= 0.6, < 0.8)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    http-cookie (1.0.4)
+    ffi (1.16.3)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    http-cookie (1.0.6)
       domain_name (~> 0.5)
-    i18n (1.8.10)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     matrix (0.4.2)
-    metainspector (5.11.2)
-      addressable (~> 2.7)
-      faraday (~> 1.4)
+    metainspector (5.15.0)
+      addressable (~> 2.8.4)
+      faraday (~> 2.5)
       faraday-cookie_jar (~> 0.0)
       faraday-encoding (~> 0.0)
-      faraday-http-cache (~> 2.2)
-      faraday_middleware (~> 1.0)
+      faraday-follow_redirects (~> 0.3)
+      faraday-gzip (>= 0.1, < 2.0)
+      faraday-http-cache (~> 2.5)
+      faraday-retry (~> 2.0)
       fastimage (~> 2.2)
       nesty (~> 1.0)
-      nokogiri (~> 1.11)
+      nokogiri (~> 1.13)
     method_source (1.0.0)
-    mime-types (3.4.1)
+    mime-types (3.5.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
-    mini_mime (1.1.2)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
-    mock_redis (0.29.0)
-      ruby2_keywords
-    multipart-post (2.1.1)
-    mustermann (1.1.1)
+    mime-types-data (3.2024.0507)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.22.2)
+    mock_redis (0.41.0)
+    mustermann (1.1.2)
       ruby2_keywords (~> 0.0.1)
+    mutex_m (0.2.0)
     nesty (1.0.2)
     net-http-persistent (3.1.0)
       connection_pool (~> 2.2)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.15.5)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     normalize_url (0.0.6)
       addressable (~> 2.3)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
-    racc (1.6.0)
+    public_suffix (5.0.4)
+    racc (1.7.3)
     rack (1.6.13)
     rack-protection (1.5.5)
       rack
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rainbow (3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rainbow (3.1.1)
     rake (10.5.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     redis (4.4.0)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    regexp_parser (2.9.0)
+    rerun (0.14.0)
+      listen (~> 3.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -174,9 +179,9 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.11.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
     selenium-webdriver (3.142.7)
@@ -186,21 +191,20 @@ GEM
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    thor (1.2.1)
-    tilt (2.0.10)
-    tzinfo (2.0.4)
+    thor (1.3.1)
+    tilt (2.3.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8)
     unicode-display_width (1.8.0)
-    websocket-driver (0.7.5)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    yard (0.9.26)
-    zeitwerk (2.4.2)
+    yard (0.9.34)
+    zeitwerk (2.6.15)
+    zlib (2.1.1)
 
 PLATFORMS
   ruby
@@ -211,11 +215,12 @@ DEPENDENCIES
   faker (~> 1.7)
   pry (~> 0.10)
   rake (~> 10.4)
+  rerun
   rspec (~> 3.4)
   rubocop (~> 0.49)
   sinatra (~> 1.4)
   wayfarer!
-  yard (~> 0.9)
+  yard
 
 BUNDLED WITH
    2.1.4

data/Rakefile

@@ -1,62 +1,11 @@
 # frozen_string_literal: true
 
 require "irb"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
+require "open-uri"
+require "zip"
 
-BUILD_DIR = "build"
+require "bundler/gem_tasks"
 
-task default: :build
-
-desc "Start an IRB session"
-task :console do
-  require_relative "lib/wayfarer"
-  ARGV.clear
-  IRB.start
-end
-
-desc "Build gem"
-task build: %i[clean] do
-  sh "gem build wayfarer.gemspec --verbose"
-  sh "mkdir #{BUILD_DIR}"
-  sh "mv wayfarer-*.gem #{BUILD_DIR}"
-end
-
-desc "Remove build directory"
-task :clean do
-  sh "rm -rf #{BUILD_DIR}"
-end
-
-desc "Install gem"
-task install: %i[build] do
-  sh "gem install #{BUILD_DIR}/*.gem"
-end
-
-namespace :test do
-  desc "Run only isolated tests"
-  RSpec::Core::RakeTask.new :isolated do |task|
-    task.rspec_opts = ["--tag ~selenium --tag ~ferrum --tag ~cli"]
-  end
+Dir.glob("rake/*.rake").each { |file| load(file) }
 
-  desc "Run only Selenium tests"
-  RSpec::Core::RakeTask.new :selenium do |task|
-    task.rspec_opts = ["--tag selenium"]
-  end
-
-  desc "Run only Ferrum tests"
-  RSpec::Core::RakeTask.new :ferrum do |task|
-    task.rspec_opts = ["--tag ferrum"]
-  end
-
-  desc "Run only CLI tests"
-  RSpec::Core::RakeTask.new :cli do |task|
-    task.rspec_opts = ["--tag cli"]
-  end
-end
-
-desc "Run all tests"
-RSpec::Core::RakeTask.new(:test)
-
-RuboCop::RakeTask.new do |task|
-  task.formatters = %w[simple]
-end
+task default: :build

data/bin/wayfarer

@@ -3,4 +3,4 @@
 
 require_relative "../lib/wayfarer"
 
-Wayfarer::CLI::Runner.start(ARGV)
+Wayfarer::CLI.start(ARGV)

data/docker-compose.yml

@@ -2,12 +2,19 @@ version: "3"
 services:
   wayfarer:
     build: .
+    tty: true
     volumes:
-    - "./:/usr/src/app"
+      - "./:/opt/app"
     ports:
-    - "9876:9876"
+      - "9876:9876"
     environment:
-    - CI=true
+      - CI=true
+    hostname: test
+    depends_on:
+      - redis
+      - chrome
+      - firefox
+      - docs
 
   redis:
     image: redis
@@ -15,18 +22,22 @@ services:
   chrome:
     image: browserless/chrome
     ports:
-    - "3000:3000"
+      - "3000:3000"
 
   firefox:
     image: selenium/standalone-firefox:4.0.0-rc-2-prerelease-20210923
     ports:
-    - "4444:4444"
+      - "4444:4444"
     volumes:
-    - "/dev/shm:/dev/shm"
+      - "/dev/shm:/dev/shm"
 
   docs:
-    image: squidfunk/mkdocs-material:7.3.0
+    image: squidfunk/mkdocs-material:9.5.9
     volumes:
-    - "./:/docs"
+      - "./:/docs"
     ports:
-    - "8000:8000"
+      - "8000:8000"
+
+networks:
+  default:
+    driver: bridge

data/docs/cookbook/consent_screen.md

@@ -6,10 +6,10 @@ iframe, clicked, and makes the live page behind the screen accessible to
 `#index`:
 
 ```ruby
-Wayfarer.config.network.agent = :ferrum
+Wayfarer.config[:network][:agent] = :ferrum
 
 class DummyJob < Wayfarer::Base
-  route { to :index, host: "example.com" }
+  route.to :index, host: "example.com"
 
   before_action if: :consent_required? do
     sleep(5) # If the consent form has a loading animation

data/docs/cookbook/executing_javascript.md

@@ -6,7 +6,7 @@ Executing JavaScript requires automating a browser.
 
     ```ruby
     class DummyJob < Wayfarer::Base
-      route { to :index }
+      route.to :index
 
       def index
         browser.evaluate("[window.scrollX, window.scrollY]")
@@ -18,7 +18,7 @@ Executing JavaScript requires automating a browser.
 
     ```ruby
     class DummyJob < Wayfarer::Base
-      route { to :index }
+      route.to :index
 
       def index
         # Mind the explicit return
@@ -31,7 +31,7 @@ Executing JavaScript requires automating a browser.
 
     ```ruby
     class DummyJob < Wayfarer::Base
-      route { to :index }
+      route.to :index
 
       def index
         # Capybara does not return value of JavaScript execution