gnome_app_driver 0.1.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c6b65ca2e0606b079cdbb7573c3dd4bf91d09eb2
-  data.tar.gz: 3b2d715bdeba926e5dac22874142f6e8a33d8e98
+SHA256:
+  metadata.gz: a7b95a34fc56c8ccd362498d4af26379b8df067db00afedc5ac25598139e4bca
+  data.tar.gz: 7eea27a9fc2dffdd2bac6579fb91f7bb45b99c581ad42043402f0e15d8e8b71b
 SHA512:
-  metadata.gz: e537ba3fa17179e47560c8c867f16648de1e3e950c5477e24f53bd7e081b670931281e22358ec6e751ad4966c2850d73560a4cf970c36c72fc459bdb76217157
-  data.tar.gz: d1378bc91adb7ab28a6d9bbe73555cf3671cd1cfae2821b0b37c3c40f122a0e81ede89ccb6e41ed44374fe343868c96c3ab5ed5cb9a22d21eeedb6819c395757
+  metadata.gz: dd4c110014b268c8efaf7e3bbfbeebca7ecab3e39a177144626a77fe94f2a7c39904f8453d40c5b11b077fc090c06aac0ba0a6856298e8fc5565455f9b44a203
+  data.tar.gz: 9bc1f5be27e18184d729be763de4fcba80dbac7dc0a84fb6505fe55771546be89eff585e89b2145498f97d0d6e041679b3d080c3ab2df76952ffc3af79d8fe7e

data/Changelog.md

@@ -1,12 +1,33 @@
 # Change log
 
+## 0.3.1 / 2022-01-26
+
+* Drop support for Ruby version 2.5
+* Support up to Ruby 3.1
+
+## 0.3.0 / 2020-11-14
+
+* Drop support for Ruby version 2.3 and 2.4
+* Remove `GnomeAppDriver#press_ctrl_q` because it does not and likely will never
+  work on Wayland. Use a regular action to quit your application instead.
+* Provide access to the main application Atspi object through `GnomeAppDriver#application`
+
+## 0.2.1 / 2018-11-03
+
+* Loosen dependencies
+
+## 0.2.0 / 2018-09-23
+
+* Target Ruby 2.3+
+* Fix `#find_role` to handle symbolic role names
+
 ## 0.1.2 / 2017-11-11
 
 * Update dependencies
 
 ## 0.1.1 / 2017-11-05
 
-* Release Ruby-GNOME2 version under a new name: gnome_app_driver
+* Release Ruby-GNOME2 version under a new name: `gnome_app_driver`
 
 ## 0.1.0 / 2017-04-25
 

data/README.md

@@ -40,7 +40,8 @@ Say, your application is called `foo`. Then, in your tests, do something like th
         textbox.get_text(0, 100).must_equal 'Foo bar baz'
 
         # Quit application
-        @driver.press_ctrl_q
+        menu_item = frame.find_role :menu_item, /Quit/
+        menu_item.do_action 0
 
         # Check exit status
         status = @driver.cleanup

data/lib/gnome_app_driver/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class GnomeAppDriver
+  VERSION = "0.3.1"
+end

data/lib/gnome_app_driver.rb

@@ -1,11 +1,14 @@
-require 'gobject-introspection'
+# frozen_string_literal: true
+
+require "gobject-introspection"
+require "gnome_app_driver/version"
 
 # Namespace for Atspi classes.
 module Atspi
 end
 
 # Load Atspi namespace with GObjectIntrospection.
-GObjectIntrospection::Loader.new(Atspi).load('Atspi')
+GObjectIntrospection::Loader.new(Atspi).load("Atspi")
 
 # Utility monkey-patches for the Atspi::Accessible class
 module AtspiAccessiblePatches
@@ -16,17 +19,20 @@ module AtspiAccessiblePatches
     end
   end
 
-  def find_role(role, regex = //)
+  # Find an element with the given role and label regex
+  def find_role(role_name, regex = //)
+    role = Atspi::Role.new role_name
     return self if role == self.role && name =~ regex
+
     each_child do |child|
-      result = child.find_role role, regex
+      result = child.find_role role_name, regex
       return result if result
     end
     nil
   end
 
   def inspect_recursive(level = 0, maxlevel = 5)
-    puts "#{'  ' * level} > name: #{name}; role: #{role}"
+    puts "#{"  " * level} > name: #{name}; role: #{role}"
     each_child do |child|
       child.inspect_recursive(level + 1) unless level >= maxlevel
     end
@@ -40,7 +46,7 @@ Atspi::Accessible.include AtspiAccessiblePatches
 class GnomeAppDriver
   def initialize(app_name, app_file: nil, verbose: false)
     @app_file = app_file || "bin/#{app_name}"
-    @lib_dir = 'lib'
+    @lib_dir = "lib"
     @app_name = app_name
     @pid = nil
     @verbose = verbose
@@ -48,10 +54,10 @@ class GnomeAppDriver
     @thread = nil
   end
 
-  attr_reader :frame
+  attr_reader :frame, :application
 
   def boot(test_timeout: 30, exit_timeout: 10, arguments: [])
-    raise 'Already booted' if @pid
+    raise "Already booted" if @pid
 
     spawn_process(arguments)
 
@@ -60,42 +66,36 @@ class GnomeAppDriver
     @frame = find_and_focus_frame
 
     @thread = Thread.new do
-      wait_for('test to be done', test_timeout) { @cleanup }
-      wait_for('pid to go away', exit_timeout) { !@pid }
+      wait_for("test to be done", test_timeout) { @cleanup }
+      wait_for("pid to go away", exit_timeout) { !@pid }
       kill_process if @pid
     end
   end
 
   def spawn_process(arguments)
-    command = "ruby -I#{@lib_dir} #{@app_file} #{arguments.join(' ')}"
+    command = "ruby -I#{@lib_dir} #{@app_file} #{arguments.join(" ")}"
     log "About to spawn: `#{command}`"
     @pid = Process.spawn command
   end
 
-  def press_ctrl_q
-    Atspi.generate_keyboard_event(37, nil, :press)
-    Atspi.generate_keyboard_event(24, nil, :pressrelease)
-    Atspi.generate_keyboard_event(37, nil, :release)
-  end
-
   def cleanup
     status = exit_status
     @pid = nil
-    @thread.join if @thread
+    @thread&.join
     status
   end
 
   private
 
   def find_and_focus_frame
-    acc = wait_for('app to appear', 10) { find_app }
-    raise 'App not found' unless acc
+    @application = wait_for("app to appear", 10) { find_app }
+    raise "App not found" unless @application
 
-    frame = acc.get_child_at_index 0
+    frame = @application.get_child_at_index 0
     role = frame.role
     raise "Frame has unexpected role #{role.inspect}" unless role == :frame
 
-    wait_for('frame to be focused', 10) do
+    wait_for("frame to be focused", 10) do
       frame.state_set.contains(Atspi::StateType::ACTIVE)
     end
 
@@ -104,7 +104,7 @@ class GnomeAppDriver
 
   def kill_process
     log "About to kill child process #{@pid}"
-    Process.kill 'KILL', @pid
+    Process.kill "KILL", @pid
   end
 
   def log(message)
@@ -127,6 +127,7 @@ class GnomeAppDriver
     50.times do |num|
       result = yield
       break if result
+
       sleep 0.01 * (num + 1)
     end
     log "Waited #{Time.now - start} seconds for #{description}"
@@ -135,6 +136,7 @@ class GnomeAppDriver
 
   def exit_status
     return unless @pid
+
     @cleanup = true
     _, status = Process.wait2 @pid
     status

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnome_app_driver
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Matijs van Zuijlen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-11 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gobject-introspection
@@ -16,104 +16,170 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: gtk3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: gtk3
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.12'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
-description: 
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+description: 'Driver to test the UI of applications using Ruby-GNOME2 by interacting
+  with them via Atspi.
+
+  '
 email:
 - matijs@matijs.net
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- Changelog.md
 files:
 - Changelog.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/gnome_app_driver.rb
+- lib/gnome_app_driver/version.rb
 homepage: http://www.github.com/mvz/ruby-gnome2_app_driver
-licenses: []
-metadata: {}
-post_install_message: 
-rdoc_options: []
+licenses:
+- LGPL-2.1+
+metadata:
+  homepage_uri: http://www.github.com/mvz/ruby-gnome2_app_driver
+  source_code_uri: https://github.com/mvz/ruby-gnome2_app_driver
+  changelog_uri: https://github.com/mvzruby-gnome2_app_driver/blob/master/Changelog.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Test Ruby-GNOME2 applications using Atspi
 test_files: []

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Rakefile

@@ -1,17 +0,0 @@
-require 'rake/clean'
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-namespace :test do
-  Rake::TestTask.new(:end_to_end) do |t|
-    t.libs = ['lib']
-    t.test_files = FileList['test/end_to_end/*_test.rb']
-    t.warning = true
-  end
-
-  task all: [:end_to_end]
-end
-
-task test: 'test:all'
-
-task default: 'test'