appium_capybara 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15eee6309ddeb8a3eb403d1467e1cd3c214bf22b929436d05b31c794c90d99ab
-  data.tar.gz: bc20ee172a29cae552480dd3f7b7bcb34f5a99ef9e7edc51caf72e602a54a0d1
+  metadata.gz: fefc79777a33211ebc6e074e06b7492c36b30c1b3e78c3238d341ed4c16ad7d9
+  data.tar.gz: '0189794800803c4d0cfc133aba42d9393f87f38ebb15effc752413e2edb71709'
 SHA512:
-  metadata.gz: d9f8cf8110506f3f4b1fa9b862fe4c94a94f68e79598b27897f336f76895241ebd866e7add1ae217f7e165b94ba35af146c0ce5fbd0b052e50584dd1f37be7b2
-  data.tar.gz: 2fbeeab4a2d1aaefa87971c0fab127bbf5bc321ab809836dee963f8b6d3a82bd89c63712a61a0d5d0d183c6b1363c9f2283577670a2c5326ccd931487e0e9948
+  metadata.gz: 78d3eeb43f5e6e36fc44672ca2f6f892506d2e5b9f488344f04348ca06bd7e75bcda3dc507a7f25158d3bc77208810f128247c49ad6dae5fcf4cee983fb6fcfd
+  data.tar.gz: 6818d7abcfcc18d0ff9d6bcb3ad8a6730b117829b1e3ccb69506f25411f2ec65be284b5a5a8a7e8572c86b804239197650ab0ff36609f05afada29c8bca6177f

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+Historical commit-level notes through 3.2.0 are in [release_notes.md](release_notes.md).
+New entries are maintained by Release Please.
+
+## [3.3.0](https://github.com/appium/appium_capybara/compare/v3.2.0...v3.3.0) (2026-10-27)
+
+
+### Features
+
+* use W3C actions for scroll_up, scroll_down, and long_press ([#83](https://github.com/appium/appium_capybara/issues/83)) ([021893a](https://github.com/appium/appium_capybara/commit/021893a2a657d31e97d476fdd3ddf48082d348d0))
+
+## [3.2.0] - 2025-01-25
+
+- See the historical release notes for this release.

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'appium_thor', '~> 2.0'
+
+gem 'rake', '~> 13.0'

data/README.md

@@ -7,30 +7,28 @@ Gem enabling appium support in capybara
 Please use `v1.4.1` for Capybara 2.x users. `v1.5.0` requires Capybara 3.x.
 
 ## Driver Setup
-Set up the appium_capybara driver by running this before starting your test.
+Set up the `appium_capybara` driver by registering `:appium` with Capybara before starting your tests:
 
 ```ruby
 require 'appium_capybara'
 
-desired_caps_ios = {
-  platform:        "Mac",
-  deviceName:      "iPhone Simulator",
-  platformName:    "iOS",
-  platformVersion: "12.4",
-  app:             "full/path/to/app.zip"
+capabilities = {
+  'platformName' => 'ios',
+  'platformVersion' => ENV['PLATFORM_VERSION'] || '17.4',
+  'appium:deviceName' => ENV['DEVICE_NAME'] || 'iPhone 15 Plus',
+  'appium:automationName' => 'xcuitest',
+  'appium:app' => File.expand_path('path/to/UICatalog.app.zip')
 }
 
-url = "http://localhost:4723/wd/hub" # or a sauce labs url
+url = 'http://localhost:4723' # or a remote/cloud server URL
 
 Capybara.register_driver(:appium) do |app|
-    appium_lib_options = {
-      server_url: url
-    }
-    all_options = {
-      appium_lib: appium_lib_options,
-      caps: desired_caps_ios
-    }
-    Appium::Capybara::Driver.new app, all_options
+  Appium::Capybara::Driver.new(
+    app,
+    capabilities: capabilities,
+    appium_lib: { server_url: url },
+    global_driver: false
+  )
 end
 
 Capybara.default_driver = :appium
@@ -48,25 +46,96 @@ Capybara.server_host = '0.0.0.0' # Listen to all interfaces
 Capybara.server_port = 56844     # Open port TCP 56844, change at your convenience
 ```
 
-## Call methods
+## Using Capybara DSL & Custom Selectors
 
-appium_capybara provides both Capybara methods and appium_lib methods.
+`appium_capybara` registers the following Appium-specific selectors with Capybara in addition to `:xpath` and `:css`:
+- `:id`
+- `:class`
+- `:name`
+- `:accessibility_id`
+- `:custom`
+
+You can query elements through `Capybara.current_session` (or directly in RSpec feature specs):
 
 ```ruby
-capy_driver = Capybara.current_session.driver
+session = Capybara.current_session
+
+# Find a single element or all matching elements using Capybara selectors
+nav_bar = session.find(:xpath, '//XCUIElementTypeNavigationBar')
+expect(nav_bar.find(:class, 'XCUIElementTypeButton').text).to eq('UIKitCatalog')
+
+buttons = session.all(:class, 'XCUIElementTypeButton')
+expect(buttons.count).to be > 0
+```
+
+> Note: Web-only Capybara navigation helpers such as `visit` or `click_link` only apply to web/hybrid contexts, not native mobile views.
 
-# Calls methods defined in Appium::Capybara::Driver and Capybara::Selenium::Driver
-capy_driver.find_custom :name, '<enter text>'
+## Using with SitePrism Page Objects
+
+`appium_capybara` works with [SitePrism](https://github.com/site-prism/site_prism) pages and sections using the registered Appium selectors:
+
+```ruby
+require 'site_prism'
+
+module Sections
+  class Sheets < SitePrism::Section
+    elements :buttons, :class, 'XCUIElementTypeButton'
+  end
+end
 
-# Calls methods defined in only appium_lib (Appium::Driver)
+module Pages
+  class Home < SitePrism::Page
+    elements :navigation_bar, :accessibility_id, 'UIKitCatalog'
+    section :action_sheets_section, Sections::Sheets, :name, 'Alert Views'
+  end
+end
+
+home_page = Pages::Home.new
+expect(home_page.navigation_bar.first).to be_truthy
+expect(home_page.action_sheets_section.has_buttons?).to be(false)
+```
+
+## Driver & Node Methods
+
+`appium_capybara` provides access to both `Appium::Capybara::Driver` helpers and the underlying `appium_lib` (`Appium::Driver`) / Selenium (`Appium::Core::Base::Driver`) instances:
+
+```ruby
+capy_driver = Capybara.current_session.driver
+
+# Find elements with any Appium finder (:predicate, :class_chain, :uiautomator, :name, etc.)
+# Returns an Array of Appium::Capybara::Node instances
+nodes = capy_driver.find_custom(:predicate, 'value == "Placeholder text"')
+node = nodes.first
+node.name       # element name attribute
+node.label      # element label attribute
+node.set('abc') # clears the element and sends keys
+node.send_keys([:shift, :end])
+
+# Perform a W3C pointer swipe gesture (duration in ms, defaults to 200)
+capy_driver.swipe(start_x: 100, start_y: 500, end_x: 100, end_y: 200, duration: 200)
+
+# Scroll or rotate via driver helpers
+capy_driver.scroll_down
+capy_driver.scroll_up
+capy_driver.rotate(:landscape) # or :portrait
+
+# Save screenshots and handle alerts
+capy_driver.save_screenshot('screen.png')
+capy_driver.accept_modal(:alert)
+capy_driver.dismiss_modal(:alert)
+
+# Call methods defined on appium_lib (Appium::Driver) directly
 capy_driver.appium_driver.find_element(:name, 'TextFields').click
 capy_driver.appium_driver.hide_keyboard
+capy_driver.appium_driver.back
 ```
 
+See the complete working example in [`example/spec/`](example/spec/).
+
 ## Publishing to rubygems
 
-Make sure to run `thor bump` or manually modify version.rb before publishing. RubyGems will not allow the same
-version to be published twice. After the version is bumped, run `thor publish`
+Review and merge the Release Please PR to publish. See [RELEASING.md](RELEASING.md)
+for one-time Trusted Publishing setup and recovery instructions.
 
 
 ## major changelogs

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/appium_capybara.gemspec

@@ -22,4 +22,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'capybara', '~> 3.36'
 
   s.files = s.remove_zip_files(`git ls-files`.split("\n"))
+  # Keep release automation out of the published package.
+  s.files.reject! do |file|
+    file.start_with?('.github/', 'script/', 'test/release/') ||
+      %w[RELEASING.md release-please-config.json .release-please-manifest.json].include?(file)
+  end
+
 end

data/contributing.md

@@ -1,24 +1,7 @@
-appium_capybara strives to follow the [GitHub Ruby style guide](https://github.com/styleguide/ruby)
+appium_capybara strives to follow the [GitHub Ruby style guide](https://github.com/styleguide/ruby).
 
+## Building and releasing
 
-# Thor commands
-
-```
-$ thor list
-default
--------
-thor build          # Build a new gem
-thor bump           # Bump the z version number and update the date.
-thor bumpx          # Bump the x version number, set y & z to zero, update the date.
-thor bumpy          # Bump the y version number, set z to zero, update the date.
-thor byte           # Remove non-ascii bytes from all *.rb files in the current dir
-thor docs           # Update docs
-thor gem_install    # Install gem
-thor gem_uninstall  # Uninstall gem
-thor info           # prints config info for this gem
-thor notes          # Update release notes
-thor publish        # Build and release a new gem to rubygems.org
-thor release        # Build and release a new gem to rubygems.org (same as publish)
-```
-
-To release use `thor bump` then `thor publish`
+Run `bundle install` and `bundle exec rake build` to build locally.
+Release validation uses the shared `ruby-release-validate` Action.
+See [RELEASING.md](RELEASING.md) for automated releases and recovery.

data/lib/appium_capybara/driver/appium/driver.rb

@@ -69,12 +69,24 @@ module Appium::Capybara
 
     # new
     def scroll_up
-      browser.execute_script('mobile: scroll', direction: 'up')
+      window = appium_driver.window_rect
+      swipe(
+        start_x: window.width / 2,
+        start_y: window.height / 10,
+        end_x: window.width / 2,
+        end_y: window.height * 8 / 10
+      )
     end
 
     # new
     def scroll_down
-      browser.execute_script('mobile: scroll', direction: 'down')
+      window = appium_driver.window_rect
+      swipe(
+        start_x: window.width / 2,
+        start_y: window.height * 8 / 10,
+        end_x: window.width / 2,
+        end_y: window.height / 10
+      )
     end
 
     # new

data/lib/appium_capybara/driver/appium/node.rb

@@ -15,9 +15,14 @@ module Appium::Capybara
     end
 
     def long_press
-      action = Appium::TouchAction.new
-      action.long_press(element: native, duration: 2000)
-      action.perform
+      action_builder = driver.browser.action
+      input = action_builder.pointer_inputs[0]
+      action_builder
+        .move_to(native)
+        .pointer_down(:left)
+        .pause(device: input, duration: 2)
+        .release
+        .perform
     end
 
     def find_custom(finder, locator)

data/lib/appium_capybara/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Capybara
-    VERSION = '3.2.0'.freeze unless defined? ::Appium::Capybara::VERSION
-    DATE    = '2025-01-25'.freeze unless defined? ::Appium::Capybara::DATE
+    VERSION = '3.3.0'.freeze unless defined? ::Appium::Capybara::VERSION
+    DATE    = '2026-10-27'.freeze unless defined? ::Appium::Capybara::DATE # x-release-please-date
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: appium_capybara
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - fly.49.89.over@gmail.com
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib
@@ -45,12 +44,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/run_example.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE-2.0.txt
 - README.md
-- Thorfile
+- Rakefile
 - appium_capybara.gemspec
 - contributing.md
 - example/Gemfile
@@ -73,7 +72,6 @@ homepage: https://github.com/appium/appium_capybara
 licenses:
 - http://www.apache.org/licenses/LICENSE-2.0.txt
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Enables appium support in Capybara
 test_files: []

data/.github/workflows/run_example.yml

@@ -1,68 +0,0 @@
-name: Run example
-
-on:
-  # Run by manual at this time
-  workflow_dispatch:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  test:
-
-    runs-on: macos-14
-
-    env:
-      PLATFORM_VERSION: '17.4'
-      XCODE_VERSION: '15.3'
-      DEVICE_NAME: iPhone 15 Plus
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Install Node.js
-      uses: actions/setup-node@v3
-      with:
-        node-version: 'lts/*'
-
-    - name: Select Xcode
-      uses: maxim-lobanov/setup-xcode@v1
-      with:
-        xcode-version: ${{ env.XCODE_VERSION }}
-    - run: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
-
-    - uses: futureware-tech/simulator-action@v3
-      with:
-        # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md
-        model: ${{ env.DEVICE_NAME }}
-        os_version: ${{ env.PLATFORM_VERSION }}
-
-    - name: Install Appium XCUITest
-      run: |
-        npm install -g appium
-        appium driver install xcuitest
-    - name: run Appium background
-      run: |
-        nohup appium --log-timestamp --log-no-colors > appium.log 2>&1 &
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.2
-    - name: Run example
-      run: |
-        bundle install
-        bundle exec rspec spec/ios_example_spec.rb
-      working-directory: example
-
-    - name: Upload appium.log
-      if: ${{ always() }}
-      uses: actions/upload-artifact@v4
-      with:
-        path: appium.log
-

data/Thorfile

@@ -1,5 +0,0 @@
-require 'appium_thor'
-
-Appium::Thor::Config.set do
-  gem_name 'appium_capybara'
-end