capybara-wsl 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e04f7c677729e9d7e3548f5982a69bbaf858e7f55834fa41b5fa5f394c2764
-  data.tar.gz: 89c9fd0d1aa1df15315587904f0a40157c93120d2078d61f4e989b21b725b186
+  metadata.gz: c268d40e531e50a7d5acc3542da8f8b8ff97f2e1f51706792ffcd3641fcd8040
+  data.tar.gz: 0b013a92616e617b2b3eec67275e36041a627cf157792bf7ed3070ef335c97ba
 SHA512:
-  metadata.gz: 62f5848e003552e5df7c55619cc30942d2367c031130a9f1cc54e408235be55cba80decb8c65a3fbd10156c677575fec04d89a27af8d40e4b686c091679ef70a
-  data.tar.gz: b4e65eae735cf4d12bce4599d443e2080a6dd8a2778e9862b966d24f2085320fd1cb2295e857ea5bf07cc2cfbbb444c4ca0c4183e3f2302f44473fe436494bc8
+  metadata.gz: dfcccaf4c7b83b9168cc2094f29b766616553dc1725d7646ca2644a3beb793008975d71291442371c22790935423f1172115e35a3af797e6f0bd7449da79a9c0
+  data.tar.gz: cdd13d5a4d73419ab540daaae213482962785e8a327024b7bf4f6afeb6c1b35cce20dbe642ca708b178a0f093ff2121b4a67f1aac90cd86582ad380d10ea4c53

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    capybara-wsl (0.2.1)
+      capybara (>= 2.0)
+      launchy (>= 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    capybara (3.33.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.5)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    regexp_parser (1.7.1)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara-wsl!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,12 +1,12 @@
- CapybaraWSL
+ capybara-wsl
 =======================
 [![Gem Version](https://badge.fury.io/rb/capybara-wsl.svg)](https://badge.fury.io/rb/capybara-wsl)
 
 #### 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.
+Capybara's `save_and_open_page` and `save_and_open_screenshot` methods don't work properly in WSL. Capybara saves pages/screenshots, but then it tries to open them via Launchy and there are several problems with that. We don't want to mess with GUI on WSL, we just want to open them in a Windows browser. However, Capybara passes a Linux path to Launchy, 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.
+This gem modifies that path to include `wsl$` part so that it's understandable for Windows browsers. It automatically detects your current WSL distro (since version 0.3.0).
 
 ### Installation
 In your `Gemfile` add:
@@ -20,15 +20,15 @@ Or `gem install capybara-wsl`, but then running it is a bit less straightforward
 ### Important note
 In order for it to work, you have to add `$BROWSER` env variable.
 ###### Example for Firefox
-In your `.bashrc` add:
+In your `.bashrc` add (notice the quotes):
 ```
-export BROWSER='/mnt/c/Program Files/Mozilla Firefox/firefox.exe'
+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.
+ `save_and_open_screenshot_wsl` instead of their normal versions. You can use same arguments.
 
  If you installed via `gem install`:
  Run `gem which capybara-wsl` in your console and copy output.
@@ -38,8 +38,3 @@ Simply use
  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/lib/capybara/wsl.rb

@@ -2,51 +2,45 @@
 
 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
+    class CannotDetectWSLPath < 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)
+        open_file(s_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)
+        open_file(s_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
+    private
 
-      @distro = name
+    def self.open_file(path)
+      wsl_path = modify_path(path)
+      Capybara.current_session.send(:open_file, wsl_path)
     end
 
-    private
-
     def self.modify_path(path)
-      path.prepend("file://///wsl$/#{distro_folder_name}")
+      path.prepend(detect_path)
     end
 
-    def self.distro_folder_name
-      return distro if distro.is_a?(String)
+    def self.detect_path
+      path = `wslpath -m "/"`&.strip
+
+      if path.empty?
+        raise(Capybara::WSL::CannotDetectWSLPath,
+          "Cannot detect WSL path. Are you sure you're running WSL?")
+      end
 
-      DISTROS[distro]
+      "file:///#{path}"
     end
   end
 end

data/lib/capybara/wsl/dsl.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Capybara
   module WSL
     module DSL
-      def save_and_open_page_wsl
-        Capybara::WSL.save_and_open_page
+      def save_and_open_page_wsl(path = nil)
+        Capybara::WSL.save_and_open_page(path)
       end
 
-      def save_and_open_screenshot_wsl
-        Capybara::WSL.save_and_open_screenshot
+      def save_and_open_screenshot_wsl(path = nil, **options)
+        Capybara::WSL.save_and_open_screenshot(path, options)
       end
     end
   end

data/lib/capybara/wsl/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module WSL
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-wsl
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Tityuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -45,11 +45,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - README.md
 - capybara-wsl.gemspec
 - lib/capybara-wsl.rb
 - lib/capybara/wsl.rb
-- lib/capybara/wsl/distros.rb
 - lib/capybara/wsl/dsl.rb
 - lib/capybara/wsl/version.rb
 homepage: https://github.com/dersnek/capybara-wsl

data/lib/capybara/wsl/distros.rb

@@ -1,16 +0,0 @@
-# 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