sparkling_watir 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1fb79506e6d1a4f5fac02234aa27b306dc4257b9ad233b431791f201161e2df
-  data.tar.gz: ab09ba90d145c958825ef0defe79f277d53cccf32fd9709e3ef89a90d14ef1ad
+  metadata.gz: 3380d869ffa3595391cc478a5d93bdb6236a767040550d964afd5e22da2aef9f
+  data.tar.gz: 2bb22863cad09f16c5b67d71350c5c582a2ebaa59783f1c6cb34e6643f9cc9e6
 SHA512:
-  metadata.gz: 48911c738df981dcf3637f4699f9b6754a1708836bf4de69644bed5978fa95f62862d09bc4d6a3cc2c5c1966ae16862fadf90c844d52c4004b24b9b534e5baca
-  data.tar.gz: 9cd71b1a686cb352805548dec1fa3fdeadd7d5d127d892ea952208f118beee85739a3d98ad77cb7c461d21b8babe739503283b054e04f6759923fcd6078448d7
+  metadata.gz: 617137f0d20e8d8b47b6b9fb156fb07ebb336cc221693fe83a29ca8161e48c689da354edc829ba284df1217252b5be33e4277c0272add29fc3a2108bc4bd5c87
+  data.tar.gz: 8b56fb08ebee6400ec7eeee70ac03c7f7797bdecc18fa1daff0b8f766018af25a13563589e999eac3f6a212fc2b15d249e93fb7685e36a56984967f7af5ec8c2

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    sparkling_watir (0.1.0)
+      appium_lib_core (~> 7.0.0)
+      watir (~> 7.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appium_lib_core (7.0.0)
+      faye-websocket (~> 0.11.0)
+      selenium-webdriver (~> 4.2, < 4.11)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    eventmachine (1.2.7)
+    faye-websocket (0.11.2)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.54.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    selenium-webdriver (4.10.0)
+      rexml (~> 3.2, >= 3.2.5)
+      rubyzip (>= 1.2.2, < 3.0)
+      websocket (~> 1.0)
+    unicode-display_width (2.4.2)
+    watir (7.1.0)
+      regexp_parser (>= 1.2, < 3)
+      selenium-webdriver (~> 4.0)
+    websocket (1.2.9)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  bundler (~> 2.4.14)
+  rake (~> 13.0.6)
+  rspec (~> 3.11.0)
+  rubocop (~> 1.27)
+  rubocop-performance (~> 1.15.0)
+  rubocop-rspec (~> 2.9.0)
+  sparkling_watir!
+
+BUNDLED WITH
+   2.4.17

data/README.md

@@ -27,7 +27,7 @@ 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)
+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.
 
@@ -35,6 +35,155 @@ If you want to switch between android and iOS capabilties just run:
 
     $ rake platform[android] or rake platform[ios]
 
+## Initialize driver
+
+You can initialize the driver with the following code:
+
+```ruby
+app = SparklingWatir::App.new(caps: opts)
+```
+The capabilities should include the server url
+
+## Gestures
+
+You can use the following gestures:
+
+**Tap:** Tap on an element
+
+```ruby
+app.tap on: button
+```
+
+**Double tap:** Double tap on an element
+
+```ruby
+app.double_tap on: button
+```
+
+**Long press:** Press for a minimum of 0.5 seconds on an element
+
+```ruby
+app.long_press on: button
+```
+
+**Swipe:** Swipes to an element, there are 4 direction available: :up, :down, :left, :right
+
+```ruby
+app.swipe to: button, direction: :up
+```
+
+**Scroll:** Scrolls until it finds an element, you need to pass a scrollable view to scroll into, there are 4 direction available: :up, :down, :left, :right.
+The default duration is 30 seconds.
+
+```ruby
+app.scroll into: scrollable_view, for: element, direction: :down, duration: 40
+```
+
+
+**More gestures coming soon**
+
+## Element
+
+You can use the following methods on an element:
+
+**wd:** Get the driver from the element
+
+```ruby
+element.wd
+```
+
+**exists?:** Returns true if element exists, else false
+
+```ruby
+element.exists?
+```
+
+**present?:** Returns true if element is present, else false
+
+```ruby
+element.present?
+```
+
+**enabled?:** Returns true if element is enabled, else false
+
+```ruby
+element.enabled?
+```
+
+**coordinates:** Returns a hash with x and y coordinates
+
+```ruby
+element.coordinates
+```
+
+**size:** Returns a hash with width and height values
+
+```ruby
+element.size
+```
+
+**bounds:** Returns a hash with x and y values representing bounds
+
+```ruby
+element.bounds
+```
+
+**center:** Returns a hash with x and y values representing center
+
+```ruby
+element.center
+```
+
+**attribute(attribute_name):** Returns the attribute value
+
+```ruby
+element.attribute('className')
+```
+
+**text:** Returns the text of the element
+
+```ruby
+element.text
+```
+
+## Waits
+
+You can use the following waits:
+
+**wait_until:** Waits until a condition is true
+
+```ruby
+element.wait_until(&:present?)
+```
+
+**wait_while:** Waits while a condition is true
+
+```ruby
+element.wait_while(&:present?)
+```
+
+## Screenshot
+
+You can use the following screenshot methods:
+
+**save:** Saves a screenshot at the given path
+
+```ruby
+app.screenshot.save("screenshot.png")
+```
+
+**png:** This method represents the screenshot as a PNG image string.
+
+```ruby
+app.screenshot.png
+```
+
+**base64:** Returns a string representing the screenshot as a Base64 encoded string
+
+```ruby
+app-screenshot.base64
+```
+
 
 ## License
 

data/lib/sparkling_watir/gestures.rb

@@ -47,10 +47,19 @@ module SparklingWatir
     end
 
     def swipe(opts = {})
-      coordinates = select_direction(opts[:to], opts[:direction])
+      coordinates = select_direction(opts[:to], opts[:direction], opts[:scrollable])
       execute_swipe(coordinates)
     end
 
+    def scroll(opts = {})
+      duration = opts[:duration] || 30
+      timeout = Time.now + duration
+      while Time.now < timeout
+        swipe to: opts[:into], direction: opts[:direction], scrollable: true
+        break if opts[:for].present?
+      end
+    end
+
     private
 
     def execute_swipe(coordinates)
@@ -69,34 +78,49 @@ module SparklingWatir
       perform finger
     end
 
-    def select_direction(element, direction)
-      case direction
-      when :down
-        start_x = element.center[:x]
-        start_y = @driver.window_size.height * 0.8
-        end_x = element.center[:x]
-        end_y = element.center[:y]
-      when :up
-        start_x = @driver.window_size.width / 2
-        start_y = @driver.window_size.height * 0.2
-        end_x = element.center[:x]
-        end_y = element.center[:y] / 0.5
-      when :left
-        start_x = @driver.window_size.width
-        start_y = element.center[:y]
-        end_x = element.center[:x]
-        end_y = element.center[:y]
-      when :right
-        start_x = @driver.window_size.width
-        start_y = element.center[:y]
-        end_x = element.center[:x]
-        end_y = element.center[:y]
-      else raise "You selected an invalid direction. The valid directions are: :down, :up, :left, :right"
-      end
+    def select_direction(element, direction, scrollable)
+      start_coordinates, end_coordinates = case direction
+                                           when :down
+                                             select_down(element)
+                                           when :up
+                                             select_up(element, scrollable)
+                                           when :left, :right
+                                             select_horizontal(element)
+                                           else
+                                             raise "You selected an invalid direction. The valid directions are: :down, :up, :left, :right"
+                                           end
+
       {
-        start_coordinates: { x: start_x, y: start_y },
-        end_coordinates: { x: end_x, y: end_y }
+        start_coordinates: { x: start_coordinates[:x], y: start_coordinates[:y] },
+        end_coordinates: { x: end_coordinates[:x], y: end_coordinates[:y] }
       }
     end
+
+    def select_down(element)
+      start_x = element.center[:x]
+      start_y = @driver.window_size.height * 0.8
+      end_x = element.center[:x]
+      end_y = element.center[:y]
+
+      [{x: start_x, y: start_y}, {x: end_x, y: end_y}]
+    end
+
+    def select_up(element, scrollable)
+      start_x = @driver.window_size.width / 2
+      start_y = @driver.window_size.height * 0.2
+      end_x = element.center[:x]
+      end_y = scrollable ? element.center[:y] : element.center[:y] / 0.5
+
+      [{x: start_x, y: start_y}, {x: end_x, y: end_y}]
+    end
+
+    def select_horizontal(element)
+      start_x = @driver.window_size.width
+      start_y = element.center[:y]
+      end_x = element.center[:x]
+      end_y = element.center[:y]
+
+      [{x: start_x, y: start_y}, {x: end_x, y: end_y}]
+    end
   end
 end

data/lib/sparkling_watir/logger.rb

@@ -1,17 +1,3 @@
-# frozen_string_literal: true
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 require 'forwardable'
 require 'logger'
 

data/lib/sparkling_watir.rb

@@ -34,6 +34,18 @@ module SparklingWatir
       Screenshot.new driver
     end
 
+    def platform
+      capabilities[:platform_name]
+    end
+
+    def android?
+      platform == 'Android'
+    end
+
+    def ios?
+      platform == 'iOS'
+    end
+
     def method_missing(method_name, *arguments, &block)
       if driver.respond_to? method_name
         driver.send method_name, *arguments, &block

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.8'
+  spec.version       = '0.1.0'
   spec.authors       = ['Agustin Pequeno']
   spec.email         = ['agustin.pe94@gmail.com']
   spec.homepage = 'https://github.com/aguspe/sparkling_watir'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkling_watir
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,6 +133,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - lib/sparkling_watir.rb