isomorfeus-puppetmaster 0.3.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b561df47e49a821a455d0034483297f2ef7623ba837dc61cca99bd5b3dd033d6
-  data.tar.gz: 409d3e25bb92e5686ec76ec91dd415ef7caedb8a90042c161721755d565ab35c
+  metadata.gz: 64b6ee2938a18c7a1c4ecfbfb021cdd9a64ea504cadd8408c474e4970725aad8
+  data.tar.gz: 943d10b0067de804930c1a516c02d6066bd33dea9fd43c134d4870328ae760e1
 SHA512:
-  metadata.gz: 950ecc09d8988b7355ee5e1f61b4d30c6ac390226c43415a0267d8c84e575c2fa93b08612e213a7945235228a1220c8b81d02fc22d2e173ad7ca74d6d7b8160e
-  data.tar.gz: 77cecab7b46eadef0f9692cf61bd02b67039896b1de1a597c23a671b6f4eed4d31f5c66fab2b41aeb2fff3f04be18041b09343bf64bb771b3251b694dd46105c
+  metadata.gz: 3e22af9d2d68ca242eeb94129cb70c205e296d85fae0eea43edea8830d1950bcd834b11071ac92ef7f41655fe08f02dad00a8c768ddd71a5eaee98fe4299caeb
+  data.tar.gz: 22e3a26aa8c6f14714e49e9949b0d853cee180bf7989242747a459d45301c6c6caf09209601e53a5e9f57037cec91db13c1a28016aab437694c07b6bf6ec1c55

data/LICENSE

@@ -19,3 +19,11 @@ 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.
+
+Files in ruby/lib/isomorfeus/puppetmaster/rspec and ruby/spec directory originally taken from https://github.com/teamcapybara/capybara
+
+(The MIT License)
+
+Copyright (c) 2009-2018 Thomas Walpole, Jonas Nicklas
+
+(as above)

data/README.md

@@ -1,8 +1,8 @@
 # isomorfeus-puppetmaster
 
 A framework for acceptance tests or simply running tests in a headless browser. 
-Comes with drivers for chromium headless and jsdom.
-Allows for writing javascript tests in pure ruby.
+Comes with drivers for chrome headless.
+Allows for writing javascript browser tests in pure ruby.
 
 ### Community and Support
 At the [Isomorfeus Framework Project](http://isomorfeus.com)
@@ -19,9 +19,7 @@ In Gemfile:
 
 Also requires the following npm modules with recommended versions:
 
-- [puppeteer 2.0.0](https://github.com/GoogleChrome/puppeteer#readme) - for the chromium driver
-- [jsdom 15.2.1](https://github.com/jsdom/jsdom#readme) - for the jsdom driver
-- [canvas 2.6.0](https://github.com/Automattic/node-canvas) - for the jsdom driver (optional)
+- [puppeteer 10.2.x](https://github.com/GoogleChrome/puppeteer#readme) - for the chrome driver
 
 Simply install them in your projects root. Puppetmaster also depends on isomorfeus-speednode, which will be installed automatically.
 Speednode will pickup the node modules then from the projects root node_modules directory.
@@ -30,27 +28,16 @@ Speednode will pickup the node modules then from the projects root node_modules
 
 Puppetmaster provides these drivers:
 - chromium - a real browser, headless, fast
-- chromium_wsl - as above but with options so it can execute within the Windows Linux WSL
 - chromium_debug - opens a chromium browser window with devtools enabled, useful for debugging tests
-- jsdom - provides a dom implementation in javascript, can execute javascript in the document, super fast, headless, has certain limitations,
-  especially because its not rendering anything (no element bounding box, etc.)
-- jsdom_canvas - jsdom driver with additional support for 'canvas', requires certain libraries to be installed, see: [canvas at github](https://github.com/Automattic/node-canvas)
 
-Chromium is the default driver. Selecting another driver, for example jsdom:
+Chrome is the default driver. Selecting another driver, for example firefox:
 ```ruby
-Isomorfeus::Puppetmaster.driver = :jsdom
+Isomorfeus::Puppetmaster.driver = :chromium_debug
 ```
 
-Puppetmaster provides support for these rack servers:
-- [agoo](https://github.com/ohler55/agoo)
-- [falcon](https://github.com/socketry/falcon)
+Puppetmaster provides support for this rack server:
 - [iodine](https://github.com/boazsegev/iodine)
-- [puma](https://github.com/puma/puma)
-
-Puma is the default rack server. To assign another rack server:
-```ruby
-Isomorfeus::Puppetmaster.server = :agoo
-```
+Iodine is the default rack server, automatically configured.
 
 Getting the app ready and running:
 1. Assign a rack app

data/lib/isomorfeus/puppetmaster/document.rb

@@ -1,268 +1,271 @@
-module Isomorfeus
-  module Puppetmaster
-    class Document
-      extend Isomorfeus::Puppetmaster::SelfForwardable
-
-      document_forward %i[
-        all_text
-        accept_alert
-        accept_confirm
-        accept_leave_page
-        accept_prompt
-        body
-        bring_to_front
-        clear_authentication_credentials
-        clear_cookies
-        clear_extra_headers
-        clear_url_blacklist
-        click
-        close
-        cookies
-        console
-        dismiss_confirm
-        dismiss_leave_page
-        dismiss_prompt
-        dispatch_event
-        double_click
-        evaluate_script
-        execute_script
-        find
-        find_all
-        find_all_xpath
-        find_xpath
-        head
-        html
-        open_new_document
-        remove_cookie
-        render_base64
-        reset_user_agent
-        right_click
-        save_pdf
-        save_screenshot
-        scroll_by
-        scroll_to
-        set_authentication_credentials
-        set_cookie
-        set_extra_headers
-        set_url_blacklist
-        set_user_agent
-        title
-        url
-        user_agent
-        viewport_maximize
-        viewport_resize
-        viewport_size
-        wait_for
-        wait_for_xpath
-      ]
-
-      attr_reader :handle, :response
-
-      def initialize(driver, handle, response)
-        @driver = driver
-        @handle = handle
-        @response = response
-        ObjectSpace.define_finalizer(self, @driver.class.document_handle_disposer(@driver, @handle))
-      end
-
-      def browser
-        @driver.browser
-      end
-
-      def await_ruby(ruby_source = '', &block)
-        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
-        ruby_source = "#{ruby_source}.then { |result| $promise_result = result; $promise_resolved = true }.fail { |result| $promise_result = result; $promise_resolved = true }"
-        compiled_ruby = compile_ruby_source(ruby_source)
-        if compiled_ruby.start_with?('/*')
-          start_of_code = compiled_ruby.index('*/') + 3
-          compiled_ruby = compiled_ruby[start_of_code..-1]
-        end
-        evaluate_script <<~JAVASCRIPT
-          (function(){
-            fun = function() {
-              if (Opal) {
-                Opal.gvars.promise_resolved = false;
-                Opal.await_ruby_exception = null;
-                try {
-                  return #{compiled_ruby}
-                } catch (e) {
-                  Opal.await_ruby_exception = e;
-                  Opal.gvars.promise_resolved = true;
-                }
-              } else {
-                setTimeout(fun, 100);
-              }
-            }
-            fun();
-          })()
-        JAVASCRIPT
-        have_result = false
-        start = Time.now
-        until have_result do
-          raise "await_ruby: execution timed out! Is Opal available?" if (Time.now - start) > 30
-          have_result = evaluate_script 'Opal ? Opal.gvars.promise_resolved : null'
-          sleep 0.1 unless have_result
-        end
-        result, exception = execute_script <<~JAVASCRIPT
-          var result;
-          var exception = false;
-          if (Opal.await_ruby_exception) {
-            var e = Opal.await_ruby_exception;
-            exception = { message: e.message, name: e.name, stack: e.stack }
-          } else if (Opal.gvars.promise_result['$respond_to?']('is_a?') && Opal.gvars.promise_result['$is_a?'](Opal.Exception)) {
-            let r = Opal.gvars.promise_result;
-            exception = { message: r.$message(), name: r.$class().$name(), stack: r.$backtrace() }
-          } else if (Opal.gvars.promise_result['$respond_to?']('to_n')) { 
-            result = Opal.gvars.promise_result.$to_n()
-          } else { result = Opal.gvars.promise_result };
-          delete Opal.gvars.promise_result;
-          delete Opal.gvars.promise_resolved;
-          return [result, exception];
-        JAVASCRIPT
-        if exception
-          e = Isomorfeus::Puppetmaster::Error.new("#{exception['name']}: #{exception['message']}")
-          e.set_backtrace(exception['stack'])
-          raise e
-        end
-        result
-      end
-
-      def evaluate_ruby(ruby_source = '', &block)
-        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
-        compiled_ruby = compile_ruby_source(ruby_source)
-        if compiled_ruby.start_with?('/*')
-          start_of_code = compiled_ruby.index('*/') + 3
-          compiled_ruby = compiled_ruby[start_of_code..-1]
-        end
-        evaluate_script <<~JAVASCRIPT
-          (function(){
-            return #{compiled_ruby}
-          })()
-        JAVASCRIPT
-      end
-
-      def evaluate_with_opal(ruby_source = '', &block)
-        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
-        compiled_ruby = compile_ruby_source(ruby_source)
-        if compiled_ruby.start_with?('/*')
-          start_of_code = compiled_ruby.index('*/') + 3
-          compiled_ruby = compiled_ruby[start_of_code..-1]
-        end
-        evaluate_script <<~JAVASCRIPT
-          (function(){
-            if (typeof Opal === "undefined") {
-              #{Isomorfeus::Puppetmaster.opal_prelude}
-            }
-            return #{compiled_ruby}
-          })()
-        JAVASCRIPT
-      end
-
-      def go_back
-        @response = @driver.document_go_back(self)
-        self
-      end
-
-      def go_forward
-        @response = @driver.document_go_forward(self)
-        self
-      end
-
-      def goto(uri)
-        @response = @driver.document_goto(self, uri)
-        self
-      end
-      alias_method :visit, :goto
-
-      def has_content?(content, **options)
-        body.has_content?(content, options)
-      end
-
-      def has_css?(selector, **options)
-        body.has_css?(selector, options)
-      end
-
-      def has_current_path?(other_path)
-        path == other_path
-      end
-
-      def has_text?(text, **options)
-        body.has_text?(text, options)
-      end
-
-      def has_xpath?(query, **options)
-        body.has_xpath?(query, options)
-      end
-
-      def isomorphic(ruby_source = '', &block)
-        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
-        Isomorfeus::Puppetmaster.served_app.on_server(ruby_source)
-        evaluate_ruby(ruby_source)
-      end
-
-      def isomorphic_with_opal(ruby_source = '', &block)
-        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
-        Isomorfeus::Puppetmaster.served_app.on_server(ruby_source)
-        evaluate_with_opal(ruby_source)
-      end
-
-      def method_missing(name, *args)
-        method_name = name.to_s
-        if method_name.start_with?('find_by_')
-          what = method_name[8..-1]
-          return find("[#{what}=\"#{args.first}\"]") if %w[name type value].include?(what)
-          return find_xpath("//*[text()=\"#{args.first}\"]") if what == 'content'
-        elsif method_name.start_with?('has_')
-          #       :has_checked_field?, #
-          #       :has_content?,
-          #       :has_css?,
-          #       :has_field?,
-          #       :has_link?,
-          #       :has_select?,
-          #       :has_selector?,
-          #       :has_table?,
-          #       :has_text?,
-          #       :has_unchecked_field?,
-          #       :has_xpath?,
-          # :has_button?, # method_missing
-        end
-        super(name, *args)
-      end
-
-      def open_document_by(&block)
-        open_documents = @driver.document_handles
-        block.call
-        new_documents = @driver.document_handles - open_documents
-        raise 'Multiple documents opened' if new_documents.size > 1
-        raise 'No window opened' if new_documents.size < 1
-        Isomorfeus::Puppetmaster::Document.new(@driver, new_documents.first, Isomorfeus::Puppetmaster::Response.new)
-      end
-
-      def path
-        URI.parse(url).path
-      end
-
-      def reload
-        @response = @driver.reload(self)
-      end
-
-      def respond_to?(name, include_private = false)
-        return true if %i[find_by_content find_by_name find_by_type find_by_value].include?(name)
-        super(name, include_private)
-      end
-
-      # assertions
-      #       :assert_current_path,
-      #       :assert_no_current_path
-      #       assert_title
-      #       assert_no_title
-
-      protected
-
-      def compile_ruby_source(source_code)
-        # TODO maybe use compile server
-        Opal.compile(source_code, parse_comments: false)
-      end
-    end
-  end
-end
+module Isomorfeus
+  module Puppetmaster
+    class Document
+      extend Isomorfeus::Puppetmaster::SelfForwardable
+
+      document_forward %i[
+        all_text
+        accept_alert
+        accept_confirm
+        accept_leave_page
+        accept_prompt
+        body
+        bring_to_front
+        clear_authentication_credentials
+        clear_cookies
+        clear_extra_headers
+        clear_url_blacklist
+        close
+        cookies
+        console
+        dismiss_confirm
+        dismiss_leave_page
+        dismiss_prompt
+        dispatch_event
+        double_click
+        evaluate_script
+        execute_script
+        find
+        find_all
+        find_all_xpath
+        find_xpath
+        head
+        html
+        open_new_document
+        remove_cookie
+        reset_user_agent
+        right_click
+        scroll_by
+        scroll_to
+        set_authentication_credentials
+        set_extra_headers
+        set_url_blacklist
+        set_user_agent
+        title
+        url
+        user_agent
+        viewport_maximize
+        viewport_resize
+        viewport_size
+        wait_for
+        wait_for_xpath
+      ]
+
+      document_forward_kwargs %i[
+        click
+        render_base64
+        save_pdf
+        save_screenshot
+        set_cookie
+      ]
+
+      attr_reader :handle, :response
+
+      def initialize(driver, handle, response)
+        @driver = driver
+        @handle = handle
+        @response = response
+        ObjectSpace.define_finalizer(self, @driver.class.document_handle_disposer(@driver, @handle))
+      end
+
+      def browser
+        @driver.browser
+      end
+
+      def await_ruby(ruby_source = '', &block)
+        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
+        ruby_source = "#{ruby_source}.then { |result| $promise_result = result; $promise_resolved = true }.fail { |result| $promise_result = result; $promise_resolved = true }"
+        compiled_ruby = compile_ruby_source(ruby_source)
+        if compiled_ruby.start_with?('/*')
+          start_of_code = compiled_ruby.index('*/') + 3
+          compiled_ruby = compiled_ruby[start_of_code..-1]
+        end
+        evaluate_script <<~JAVASCRIPT
+          (function(){
+            fun = function() {
+              if (Opal) {
+                Opal.gvars.promise_resolved = false;
+                Opal.await_ruby_exception = null;
+                try {
+                  return #{compiled_ruby}
+                } catch (e) {
+                  Opal.await_ruby_exception = e;
+                  Opal.gvars.promise_resolved = true;
+                }
+              } else {
+                setTimeout(fun, 100);
+              }
+            }
+            fun();
+          })()
+        JAVASCRIPT
+        have_result = false
+        start = Time.now
+        until have_result do
+          raise "await_ruby: execution timed out! Is Opal available?" if (Time.now - start) > 30
+          have_result = evaluate_script 'Opal ? Opal.gvars.promise_resolved : null'
+          sleep 0.1 unless have_result
+        end
+        result, exception = execute_script <<~JAVASCRIPT
+          var result;
+          var exception = false;
+          if (Opal.await_ruby_exception) {
+            var e = Opal.await_ruby_exception;
+            exception = { message: e.message, name: e.name, stack: e.stack }
+          } else if (Opal.gvars.promise_result['$respond_to?']('is_a?') && Opal.gvars.promise_result['$is_a?'](Opal.Exception)) {
+            let r = Opal.gvars.promise_result;
+            exception = { message: r.$message(), name: r.$class().$name(), stack: r.$backtrace() }
+          } else if (Opal.gvars.promise_result['$respond_to?']('to_n')) { 
+            result = Opal.gvars.promise_result.$to_n()
+          } else { result = Opal.gvars.promise_result };
+          delete Opal.gvars.promise_result;
+          delete Opal.gvars.promise_resolved;
+          return [result, exception];
+        JAVASCRIPT
+        if exception
+          e = Isomorfeus::Puppetmaster::Error.new("#{exception['name']}: #{exception['message']}")
+          e.set_backtrace(exception['stack'])
+          raise e
+        end
+        result
+      end
+
+      def evaluate_ruby(ruby_source = '', &block)
+        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
+        compiled_ruby = compile_ruby_source(ruby_source)
+        if compiled_ruby.start_with?('/*')
+          start_of_code = compiled_ruby.index('*/') + 3
+          compiled_ruby = compiled_ruby[start_of_code..-1]
+        end
+        evaluate_script <<~JAVASCRIPT
+          (function(){
+            return #{compiled_ruby}
+          })()
+        JAVASCRIPT
+      end
+
+      def evaluate_with_opal(ruby_source = '', &block)
+        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
+        compiled_ruby = compile_ruby_source(ruby_source)
+        if compiled_ruby.start_with?('/*')
+          start_of_code = compiled_ruby.index('*/') + 3
+          compiled_ruby = compiled_ruby[start_of_code..-1]
+        end
+        evaluate_script <<~JAVASCRIPT
+          (function(){
+            if (typeof Opal === "undefined") {
+              #{Isomorfeus::Puppetmaster.opal_prelude}
+            }
+            return #{compiled_ruby}
+          })()
+        JAVASCRIPT
+      end
+
+      def go_back
+        @response = @driver.document_go_back(self)
+        self
+      end
+
+      def go_forward
+        @response = @driver.document_go_forward(self)
+        self
+      end
+
+      def goto(uri)
+        @response = @driver.document_goto(self, uri)
+        self
+      end
+      alias_method :visit, :goto
+
+      def has_content?(content, **options)
+        body.has_content?(content, **options)
+      end
+
+      def has_css?(selector, **options)
+        body.has_css?(selector, **options)
+      end
+
+      def has_current_path?(other_path)
+        path == other_path
+      end
+
+      def has_text?(text, **options)
+        body.has_text?(text, **options)
+      end
+
+      def has_xpath?(query, **options)
+        body.has_xpath?(query, **options)
+      end
+
+      def isomorphic(ruby_source = '', &block)
+        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
+        Isomorfeus::Puppetmaster.served_app.on_server(ruby_source)
+        evaluate_ruby(ruby_source)
+      end
+
+      def isomorphic_with_opal(ruby_source = '', &block)
+        ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
+        Isomorfeus::Puppetmaster.served_app.on_server(ruby_source)
+        evaluate_with_opal(ruby_source)
+      end
+
+      def method_missing(name, *args)
+        method_name = name.to_s
+        if method_name.start_with?('find_by_')
+          what = method_name[8..-1]
+          return find("[#{what}=\"#{args.first}\"]") if %w[name type value].include?(what)
+          return find_xpath("//*[text()=\"#{args.first}\"]") if what == 'content'
+        elsif method_name.start_with?('has_')
+          #       :has_checked_field?, #
+          #       :has_content?,
+          #       :has_css?,
+          #       :has_field?,
+          #       :has_link?,
+          #       :has_select?,
+          #       :has_selector?,
+          #       :has_table?,
+          #       :has_text?,
+          #       :has_unchecked_field?,
+          #       :has_xpath?,
+          # :has_button?, # method_missing
+        end
+        super(name, *args)
+      end
+
+      def open_document_by(&block)
+        open_documents = @driver.document_handles
+        block.call
+        new_documents = @driver.document_handles - open_documents
+        raise 'Multiple documents opened' if new_documents.size > 1
+        raise 'No window opened' if new_documents.size < 1
+        Isomorfeus::Puppetmaster::Document.new(@driver, new_documents.first, Isomorfeus::Puppetmaster::Response.new)
+      end
+
+      def path
+        URI.parse(url).path
+      end
+
+      def reload
+        @response = @driver.reload(self)
+      end
+
+      def respond_to?(name, include_private = false)
+        return true if %i[find_by_content find_by_name find_by_type find_by_value].include?(name)
+        super(name, include_private)
+      end
+
+      # assertions
+      #       :assert_current_path,
+      #       :assert_no_current_path
+      #       assert_title
+      #       assert_no_title
+
+      protected
+
+      def compile_ruby_source(source_code)
+        # TODO maybe use compile server, which can cache code
+        Opal.compile(source_code, parse_comments: false)
+      end
+    end
+  end
+end