capybara-wsl 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 677b081aa2669018eacb29b107de53fed0b6504a3e68484d193446084e5392a5
+  data.tar.gz: 782cf20c5c5ec1623ae71c3d3410af23b12eebe231bf7cfbd3b4927e9eac29f6
+SHA512:
+  metadata.gz: c05a9ce925c9ba369ec21eb13099d6d5de64a9924cabcee79dfbafe74d142445869bf4cc46a981a3495d88d6da1747edc7290925cf0d843bbe32eb12cae17fe8
+  data.tar.gz: 1a36d375e350a2d98680ce20b653648327e9a82e1cf07674e5f68f6c2326199d470d5804c2fffa0e387363f9f0d5962b8c32f596f644a2d0505346ed4418394c

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+ CapybaraWSL
+=======================
+
+#### Allows you use open saved pages from WSL
+
+Capybara's `save_and_open_page` and `save_and_open_screenshot` methods don't work properly in WSL. It saves pages/screenshots, but when it tries to open them via Launchy, it passes Linux path, which obviously wouldn't work in Windows browsers.
+
+This gem modifies that path to include `wsl$` part so that it's understandable for Windows browsers.
+
+### Installation
+In your `Gemfile` add:
+```
+gem "capybara-wsl", git: "git@github.com:dersnek/capybara-wsl.git"
+```
+Then run `bundle install`.
+
+Or via [specific_install](https://github.com/rdp/specific_install) gem if you don't want to clutter your `Gemfile`.
+
+### Important note
+In order for it to work, you have to add `$BROWSER` env variable.
+###### Example for Firefox
+In your `.bashrc` add:
+```
+export BROWSER='/mnt/c/Program Files/Mozilla Firefox/firefox.exe'
+```
+
+### Usage
+Simply use
+ `save_and_open_page_wsl` or
+ `save_and_open_screenshot_wsl` instead of their normal versions.
+
+ If you installed via `gem install`:
+ Run `gem which capybara-wsl` in your console and copy output.
+ Use as:
+ ```
+ require "copied output"
+ Capybara::WSL.save_and_open_page
+ Capybara::WSL.save_and_open_screenshot
+ ```
+
+CapybaraWSL converts page/screenshot path to WSL Ubuntu path by default. If you have another distro, please set the `distro` setting `Capybara::WSL.distro = :debian` to whichever distro you are using.
+You can look up available distro keys in `Capybara::WSL::DISTROS`. You can also set `distro` to a string with exact folder name of your distro `Capybara::WSL.distro = "openSUSE-Leap-15-1"`.
+
+Please tell me if some of those distro folder names in `Capybara::WSL::DISTROS` are incorrect, I don't really have a way to check it.

data/capybara-wsl.gemspec

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = "capybara-wsl"
+  s.version     = "0.2.0"
+  s.date        = "2020-06-24"
+  s.summary     = "WSL support for Capybara"
+  s.description = "Allows Capybara to open pages/screenshots in Windows browsers via Launchy."
+  s.authors     = ["Mark Tityuk"]
+  s.email       = "mark.tityuk@gmail.com"
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = "https://github.com/dersnek/capybara-wsl"
+  s.license     = "MIT"
+
+  s.add_dependency "capybara", ">= 2.0"
+  s.add_dependency "launchy", ">= 2.0"
+end

data/lib/capybara-wsl.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "capybara/wsl"

data/lib/capybara/wsl.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "capybara"
+require "capybara/dsl"
+require_relative "wsl/distros"
+require_relative "wsl/dsl"
+
+module Capybara
+  module WSL
+    class CapybaraWSLError < StandardError; end
+    class DistroKeyNotSupported < CapybaraWSLError; end
+
+    def self.save_and_open_page(path = nil)
+      Capybara.current_session.save_page(path).tap do |s_path|
+        wsl_path = modify_path(s_path)
+        Capybara.current_session.send(:open_file, wsl_path)
+      end
+    end
+
+    def self.save_and_open_screenshot(path = nil, **options)
+      Capybara.current_session.save_screenshot(path, options).tap do |s_path|
+        wsl_path = modify_path(s_path)
+        Capybara.current_session.send(:open_file, wsl_path)
+      end
+    end
+
+    def self.distro
+      @distro || :ubuntu
+    end
+
+    def self.distro=(name)
+      if name.is_a?(Symbol) && DISTROS[name].nil?
+        raise(Capybara::WSL::DistroKeyNotSupported,
+              "This distro key is not supported. Please use supported key or pass a string with exact distro folder name.")
+      end
+
+      @distro = name
+    end
+
+    private
+
+    def self.modify_path(path)
+      path.gsub "/home/", "file://///wsl$/#{distro_folder_name}/home/"
+    end
+
+    def self.distro_folder_name
+      return distro if distro.is_a?(String)
+
+      DISTROS[distro]
+    end
+  end
+end
+
+# Add WSL-relared methods to Capybara's DSL
+Capybara::DSL.include Capybara::WSL::DSL

data/lib/capybara/wsl/distros.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Capybara
+  module WSL
+    DISTROS = {
+      alpine: "Alpine-WSL",
+      centos: "CentOS",
+      debian: "Debian",
+      fedors: "Fedora-Remix-for-WSL",
+      kali: "kali-linux",
+      opensuse: "openSUSE-Leap-15-1",
+      pengwin: "Pengwin",
+      ubuntu: "Ubuntu",
+    }.freeze
+  end
+end

data/lib/capybara/wsl/dsl.rb

@@ -0,0 +1,13 @@
+module Capybara
+  module WSL
+    module DSL
+      def save_and_open_page_wsl
+        Capybara::WSL.save_and_open_page
+      end
+
+      def save_and_open_screenshot_wsl
+        Capybara::WSL.save_and_open_screenshot
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: capybara-wsl
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mark Tityuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Allows Capybara to open pages/screenshots in Windows browsers via Launchy.
+email: mark.tityuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- capybara-wsl.gemspec
+- lib/capybara-wsl.rb
+- lib/capybara/wsl.rb
+- lib/capybara/wsl/distros.rb
+- lib/capybara/wsl/dsl.rb
+homepage: https://github.com/dersnek/capybara-wsl
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: WSL support for Capybara
+test_files: []