sparkling_watir 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8be8569b5d465e5b41cb77eebbab26537fdb755db47a0e486245e236535123fb
-  data.tar.gz: 2b5d78461d1c67bb27a01137f6cb549cac39265c675e88e6690fc66e56cfd390
+  metadata.gz: bb2b6d1396c00f3a2e8456284f6b65dff1280bd79dd20d1e8f3188eb1006248f
+  data.tar.gz: 823a50280dec7f29ba2b2b9c4d0009f5568f206cff41ec2b723af53016c0b071
 SHA512:
-  metadata.gz: d9c368c193abb1b26507a8598ce60afb25a7de718e9325c0e5cb2254169ce7a5cf9cc5582fa2b9a67236cc29da60a1bc516bdf4a89a267c0b37318a99288a0f3
-  data.tar.gz: c2e9f30535754c03a862274c6360d8b76a13b5a139b3d32baf5eb65663615796d871d8d859b3b7c305e713002d2b31f0e390b458e28f7db668612a18fe6ffbe7
+  metadata.gz: 3d3298d8f14bf3c2b4928937be8199cd47852b37e30a3f44f6735dd7cf16c6504bc218a3ec4f1e1547333d3a4ab086226940317ab3ed45bf78d45e7360e6cf5e
+  data.tar.gz: f6a4244e7bda0712f10879d3c39f70f75f5232974ab5bedbe1df0a2abaed6e9f14149167f8839ddc4b93185f4fd694c526fa44ebfd31866fc7f9c7edf23362b5

data/.idea/sparkling_watir.iml

@@ -11,11 +11,34 @@
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="appium_lib_core (v5.3.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="bundler (v2.3.17, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="childprocess (v4.1.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="eventmachine (v1.2.7, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="faye-websocket (v0.11.1, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.22.1, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.1.2.1, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.5.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec (v3.11.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.11.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.11.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.11.1, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.11.0, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop (v0.93.1, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.21.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubyzip (v2.3.2, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="selenium-webdriver (v4.4.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v1.8.0, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="watir (v7.1.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="websocket (v1.2.9, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="websocket-driver (v0.7.5, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="websocket-extensions (v0.1.5, RVM: ruby-3.1.0) [gem]" level="application" />
   </component>
   <component name="RakeTasksCache">
     <option name="myRootTask">

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sparkling_watir (0.0.1)
+    sparkling_watir (0.0.2)
       appium_lib_core (~> 5.3.0)
       watir (~> 7.1.0)
 

data/README.md

@@ -1,11 +1,15 @@
 # SparklingWatir
 
 Watir for testing your Mobile Devices. Powered by Appium.
-This project is a revamp of Tap watir https://github.com/watir/tap_watir.
+This project is a revamp of [Tap watir](https://github.com/watir/tap_watir).
 
 All the inspiration from this project is taking from Tap Watir, so all the credit goes
 to the original creators and contributors
 
+If you don't know the watir project here is the [link to the project](http://watir.com/)
+
+This project is still in an alpha stage and under active development.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,6 +26,16 @@ Or install it yourself as:
 
     $ gem install sparkling_watir
 
+If you want to run the tests on iOS just create a simulator that is an iPhone 8 with os 15.5 or you can change 
+the capabilities in spec/config/caps and you can download the testing app [here](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)
+
+All the credit for the testing app goes to Jonathan Lipps.
+
+If you want to switch between android and iOS capabilties just run:
+
+    $ rake platform[android] or rake platform[ios]
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'yaml'
+
+desc 'Changes the default platform'
+task :platform, [:platform] do |_t, args|
+  config = YAML.load_file('./spec/config/caps.yml')
+  config['default_platform'] = args.platform
+  File.open('./spec/config/caps.yml', 'w') { |file| YAML.dump(config, file) }
+end

data/lib/sparkling_watir/element.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
+require_relative 'gestures'
+require_relative 'wait'
 
 module SparklingWatir
-
   #
   # This is a element in the native app context
   #
   class Element
+    include Gestures
+    include Waitable
+
     def initialize(driver, selector)
       @driver = driver
       @selector = selector
@@ -48,7 +52,7 @@ module SparklingWatir
     end
 
     def bounds
-      {x: coordinates.x + size.width, y: coordinates.y + size.height}
+      { x: coordinates.x + size.width, y: coordinates.y + size.height }
     end
 
     private

data/lib/sparkling_watir/gestures.rb

@@ -0,0 +1,39 @@
+require 'appium_lib_core/common/touch_action/touch_actions'
+require 'selenium/webdriver/common/interactions/interactions'
+
+module SparklingWatir
+  module Gestures
+
+    VIEWPORT = ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT
+
+    def action(kind, name)
+      @driver.action.add_pointer_input(kind, name)
+    end
+
+    def perform(*actions)
+      @driver.perform_actions actions
+    end
+
+    def tap
+      tap = action(:touch, 'tap')
+      tap.create_pointer_move(duration: 0.1, x: bounds[:x], y: bounds[:y] - 1, origin: VIEWPORT)
+      tap.create_pointer_down(:left)
+      tap.create_pointer_up(:left)
+      perform tap
+    end
+
+    alias press tap
+
+    def double_tap
+      double_tap = action(:touch, 'double_tap')
+      double_tap.create_pointer_move(duration: 0.1, x: bounds[:x], y: bounds[:y] - 1, origin: VIEWPORT)
+      double_tap.create_pointer_down(:left)
+      double_tap.create_pointer_up(:left)
+      double_tap.create_pause(0.5)
+      double_tap.create_pointer_down(:left)
+      double_tap.create_pointer_up(:left)
+
+      perform double_tap
+    end
+  end
+end

data/lib/sparkling_watir/wait/timer.rb

@@ -0,0 +1,50 @@
+module SparklingWatir
+  module Wait
+    class Timer
+      def initialize(timeout: nil)
+        @end_time = timeout ? current_time + timeout : nil
+        @remaining_time = @end_time - current_time if @end_time
+      end
+
+      #
+      # Executes given block until it returns true or exceeds timeout.
+      # @param [Integer] timeout
+      # @yield block
+      # @api private
+      #
+
+      def wait(timeout, &block)
+        end_time = @end_time || current_time + timeout
+        loop do
+          yield(block)
+          @remaining_time = end_time - current_time
+          break if @remaining_time.negative?
+        end
+      end
+
+      def remaining_time
+        @end_time - current_time
+      end
+
+      def reset!
+        @end_time = nil
+      end
+
+      def locked?
+        !@end_time.nil?
+      end
+
+      private
+
+      if defined?(Process::CLOCK_MONOTONIC)
+        def current_time
+          Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+      else
+        def current_time
+          ::Time.now.to_f
+        end
+      end
+    end # Timer
+  end # Wait
+end # SparklingWatir

data/lib/sparkling_watir/wait.rb

@@ -0,0 +1,149 @@
+require_relative 'wait/timer'
+
+module SparklingWatir
+  module Wait
+    class TimeoutError < StandardError; end
+
+    INTERVAL = 0.1
+
+    class << self
+      #
+      # @!attribute timer
+      #   Access TapWatir timer implementation in use.
+      #   @see Timer
+      #   @return [#wait]
+      #
+
+      attr_writer :timer
+
+      def timer
+        @timer ||= Timer.new
+      end
+
+      #
+      # Waits until the block evaluates to true or times out.
+      #
+      # @example
+      # TODO: Add examples
+      #
+      # @param [Integer] timeout How long to wait in seconds
+      # @param [String] message Message to raise if timeout is exceeded
+      # @param [Object, NilClass] object Object to evaluate block against
+      # @raise [TimeoutError] if timeout is exceeded
+      #
+
+      def until(timeout: nil, message: nil, interval: nil, object: nil)
+        timeout ||= Watir.default_timeout
+        run_with_timer(timeout, interval) do
+          result = yield(object)
+          return result if result
+        end
+         raise TimeoutError, message_for(timeout, object, message)
+      end
+
+      #
+      # Wait while the block evaluates to true or times out.
+      #
+      # @example
+      # TODO: Add examples
+      #
+      # @param [Integer] timeout How long to wait in seconds
+      # @param [String] message Message to raise if timeout is exceeded
+      # @param [Object, NilClass] object Object to evaluate block against
+      # @raise [TimeoutError] if timeout is exceeded
+      #
+
+      def while(timeout: nil, message: nil, interval: nil, object: nil)
+        timeout ||= Watir.default_timeout
+        run_with_timer(timeout, interval) { return unless yield(object) }
+        raise TimeoutError, message_for(timeout, object, message)
+      end
+
+      private
+
+      def message_for(timeout, object, message)
+        message = message.call(object) if message.is_a?(Proc)
+        err = "timed out after #{timeout} seconds"
+        err << ", #{message}" if message
+
+        err
+      end
+
+      def run_with_timer(timeout, interval)
+        if timeout.zero?
+          yield
+        else
+          timer.wait(timeout) do
+            yield
+            sleep interval || INTERVAL
+          end
+        end
+      end
+    end # self
+  end # Wait
+
+  module Waitable
+    #
+    # Waits until the condition is true.
+    #
+    # @example
+    # TODO: Add examples
+    #
+
+    def wait_until(timeout: nil, message: nil, interval: nil, **opt, &blk)
+      message ||= proc { |obj| "waiting for true condition on #{obj.inspect}" }
+
+      # TODO: Consider throwing argument error for mixing block & options
+      proc = create_proc(opt, &blk)
+
+      Wait.until(timeout: timeout, message: message, interval: interval, object: self, &proc)
+
+      self
+    end
+
+    #
+    # @example
+    # Add examples
+    #
+    def wait_while(timeout: nil, message: nil, interval: nil, **opt, &blk)
+      message ||= proc { |obj| "waiting for false condition on #{obj.inspect}" }
+
+      # TODO: Add examples
+      proc = create_proc(opt, &blk)
+
+      Wait.while(timeout: timeout, message: message, interval: interval, object: self, &proc)
+
+      self
+    end
+
+    private
+
+    def create_proc(opt)
+      proc do
+        reset! if opt.delete(:element_reset) && is_a?(Element)
+        (opt.empty? || match_attributes(opt).call) && (!block_given? || yield(self))
+      end
+    end
+
+    def match_attributes(opt)
+      proc do
+        opt.keys.all? do |key|
+          expected = opt[key]
+          actual = if is_a?(Element) && !respond_to?(key)
+                     attribute_value(key)
+                   else
+                     send(key)
+                   end
+          case expected
+          when Regexp
+            expected =~ actual
+          when Numeric
+            expected == actual
+          else
+            expected.to_s == actual
+          end
+        end
+      end
+    end
+  end # Waitable
+end # SparklingWatir

data/lib/sparkling_watir.rb

@@ -2,36 +2,37 @@ require 'appium_lib_core'
 require 'watir'
 
 module SparklingWatir
-    #
-    # For driving a native application or a native app context
-    #
-    class App
-      attr_accessor :driver
+  #
+  # For driving a native application or a native app context
+  #
+  class App
+    attr_accessor :driver
 
-      def initialize(opts)
-        url = opts[:caps].delete(:url)
-        @driver = Appium::Core::Driver.for(opts).start_driver(server_url: url)
-      end
+    def initialize(opts)
+      url = opts[:caps].delete(:url)
+      @driver = Appium::Core::Driver.for(opts).start_driver(server_url: url)
+    end
 
-      def quit
-        @driver.quit
-      end
-      alias close quit
+    def quit
+      @driver.quit
+    end
 
-      def element(selector)
-        Element.new(driver, selector)
-      end
+    alias close quit
 
-      def method_missing(method_name, *arguments, &block)
-        if driver.respond_to? method_name
-          driver.send method_name, *arguments, &block
-        else
-          super
-        end
-      end
+    def element(selector)
+      Element.new(driver, selector)
+    end
 
-      def respond_to_missing?(method_name, include_private = false)
-        driver.respond_to?(method_name) || super
+    def method_missing(method_name, *arguments, &block)
+      if driver.respond_to? method_name
+        driver.send method_name, *arguments, &block
+      else
+        super
       end
     end
+
+    def respond_to_missing?(method_name, include_private = false)
+      driver.respond_to?(method_name) || super
+    end
+  end
 end

data/sparkling_watir.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'sparkling_watir'
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.2'
   spec.authors       = ['Agustin Pequeno']
   spec.email         = ['agustin.pe94@gmail.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkling_watir
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,9 @@ files:
 - Rakefile
 - lib/sparkling_watir.rb
 - lib/sparkling_watir/element.rb
+- lib/sparkling_watir/gestures.rb
+- lib/sparkling_watir/wait.rb
+- lib/sparkling_watir/wait/timer.rb
 - sparkling_watir.gemspec
 homepage:
 licenses: