appium_lib_core 0.1.0

data/lib/appium_lib_core/ios.rb

@@ -0,0 +1,7 @@
+# loaded in common/driver.rb
+require_relative 'ios/search_context'
+require_relative 'ios/device'
+require_relative 'ios/touch'
+
+require_relative 'ios/uiautomation/patch'
+require_relative 'ios/uiautomation/bridge'

data/lib/appium_lib_core/ios/device.rb

@@ -0,0 +1,54 @@
+module Appium
+  module Ios
+    module Device
+      extend Forwardable
+
+      # @!method touch_id(match = true)
+      # An instance method of Appium::Core::Device .
+      # Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint.
+      # @param [Boolean] match fingerprint validity. Defaults to true.
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.touch_id true #=> Simulate valid fingerprint
+      #   @driver.touch_id false #=> Simulate invalid fingerprint
+      #
+
+      # @!method toggle_touch_id_enrollment(enabled = true)
+      # An instance method of Appium::Core::Device .
+      # Toggle touch id enrollment on an iOS Simulator.
+      # @param [Boolean] enabled Enable toggle touch id enrollment. Set true by default.
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.toggle_touch_id_enrollment       #=> Enable toggle enrolled
+      #   @driver.toggle_touch_id_enrollment true  #=> Enable toggle enrolled
+      #   @driver.toggle_touch_id_enrollment false #=> Disable toggle enrolled
+      #
+
+      ####
+      ## class << self
+      ####
+
+      class << self
+        def extended(_mod)
+          ::Appium::Core::Device.extend_webdriver_with_forwardable
+
+          ::Appium::Core::Device.add_endpoint_method(:touch_id) do
+            def touch_id(match = true)
+              execute :touch_id, {}, match: match
+            end
+          end
+
+          ::Appium::Core::Device.add_endpoint_method(:toggle_touch_id_enrollment) do
+            def toggle_touch_id_enrollment(enabled = true)
+              execute :toggle_touch_id_enrollment, {}, enabled: enabled
+            end
+          end
+        end
+      end
+    end # module Device
+  end # module iOS
+end # module Appium

data/lib/appium_lib_core/ios/search_context.rb

@@ -0,0 +1,27 @@
+module Appium
+  module Core
+    module Ios
+      module SearchContext
+        # @!method uiautomation_find
+        #   find_element/s can be used with a [UIAutomation command](https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930).
+        #
+        # @example
+        #   find_elements :uiautomation, 'elements()
+        #
+        #
+        # @!method ios_predicate_string_find
+        #   find_element/s can be used with a [Predicates](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/Predicates/AdditionalChapters/Introduction.html)
+        #
+        # @example
+        #  find_elements :predicate, "isWDVisible == 1"
+        #  find_elements :predicate, 'wdName == "Buttons"'
+        #  find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1'
+        #
+        def self.extend
+          ::Appium::Core::Base::SearchContext.add_finders(uiautomation: '-ios uiautomation')
+          ::Appium::Core::Base::SearchContext.add_finders(predicate: '-ios predicate string')
+        end
+      end # class << self
+    end # module Ios
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/ios/touch.rb

@@ -0,0 +1,17 @@
+module Appium
+  module Core
+    module Ios
+      module Touch
+        def self.extend_touch_actions
+          ::Appium::Core::TouchAction.class_eval do
+            def swipe_coordinates(start_x: 0, start_y: 0, offset_x: 0, offset_y: 0)
+              Appium::Logger.info "extended Appium::Core::Ios::Touch, start_x: #{start_x},"\
+                " start_y: #{start_y}, offset_x: #{offset_x}, offset_y: #{offset_y}"
+              { offset_x: offset_x, offset_y: offset_y }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/ios/uiautomation/bridge.rb

@@ -0,0 +1,18 @@
+module Appium
+  module Core
+    module Ios
+      module Uiautomation
+        module Bridge
+          def self.for(target)
+            Core::Ios::SearchContext.extend
+            target.extend Appium::Ios::Device
+
+            Core::Ios::Uiautomation.patch_webdriver_element
+
+            Core::Ios::Touch.extend_touch_actions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/ios/uiautomation/patch.rb

@@ -0,0 +1,20 @@
+module Appium
+  module Core
+    module Ios
+      module Uiautomation
+        # @private
+        # class_eval inside a method because class Selenium::WebDriver::Element
+        # will trigger as soon as the file is required. in contrast a method
+        # will trigger only when invoked.
+        def self.patch_webdriver_element
+          ::Selenium::WebDriver::Element.class_eval do
+            # Cross platform way of entering text into a textfield
+            def type(text, driver)
+              driver.execute_script %(au.getElement('#{ref}').setValue('#{text}');)
+            end # def type
+          end # Selenium::WebDriver::Element.class_eval
+        end # def patch_webdriver_element
+      end # module Uiautomation
+    end # module Ios
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/ios/xcuitest/bridge.rb

@@ -0,0 +1,18 @@
+module Appium
+  module Core
+    module Ios
+      module Xcuitest
+        module Bridge
+          def self.for(target)
+            Core::Ios::SearchContext.extend
+            Core::Ios::Xcuitest::SearchContext.extend
+            target.extend Appium::Ios::Device
+            target.extend Appium::Ios::Xcuitest::Device
+
+            Core::Ios::Touch.extend_touch_actions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/ios/xcuitest/device.rb

@@ -0,0 +1,66 @@
+module Appium
+  module Ios
+    module Xcuitest
+      module Device
+        extend Forwardable
+
+        # @!method hide_keyboard(close_key = nil, strategy = nil)
+        # Hide the onscreen keyboard
+        # @param [String] close_key The name of the key which closes the keyboard.
+        # @param [Symbol] strategy The symbol of the strategy which closes the keyboard.
+        #   XCUITest ignore this argument.
+        #   Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
+        #
+        # @example
+        #
+        #  @driver.hide_keyboard             # Close a keyboard with the 'Done' button
+        #  @driver.hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
+        #
+
+        # @!method background_app(duration = 0)
+        # Backgrounds the app for a set number of seconds.
+        # This is a blocking application.
+        # @param [Integer] duration How many seconds to background the app for.
+        #
+        # @example
+        #
+        #   @driver.background_app
+        #   @driver.background_app(5)
+        #   @driver.background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
+        #
+
+        ####
+        ## class << self
+        ####
+
+        class << self
+          def extended(_mod)
+            ::Appium::Core::Device.extend_webdriver_with_forwardable
+
+            # Override
+            ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
+              def hide_keyboard(close_key = nil, strategy = nil)
+                option = {}
+
+                option[:key] = close_key if close_key
+                option[:strategy] = strategy if strategy
+
+                execute :hide_keyboard, {}, option
+              end
+            end
+
+            # Override
+            ::Appium::Core::Device.add_endpoint_method(:background_app) do
+              def background_app(duration = 0)
+                # https://github.com/appium/ruby_lib/issues/500, https://github.com/appium/appium/issues/7741
+                # `execute :background_app, {}, seconds: { timeout: duration_milli_sec }` works over Appium 1.6.4
+                duration_milli_sec = duration.nil? ? nil : duration * 1000
+                execute :background_app, {}, seconds: { timeout: duration_milli_sec }
+              end
+            end
+          end
+        end # class << self
+      end # module Device
+    end # module Xcuitest
+  end # module Ios
+end # module Appium

data/lib/appium_lib_core/ios/xcuitest/search_context.rb

@@ -0,0 +1,40 @@
+module Appium
+  module Core
+    module Ios
+      module Xcuitest
+        module SearchContext
+          # @!method ios_class_chain_find
+          #   Only for XCUITest(WebDriverAgent)
+          #   find_element/s can be used with a [class chain]( https://github.com/facebook/WebDriverAgent/wiki/Queries)
+          #
+          # @example
+          #
+          #   # select the third child button of the first child window element
+          #   find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
+          #
+          #   # select all the children windows
+          #   find_elements :class_chain, 'XCUIElementTypeWindow'
+          #
+          #   # select the second last child of the second child window
+          #   find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
+          #
+          #   # matching predicate. <code>`</code> is the mark.
+          #   find_elements :class_chain, 'XCUIElementTypeWindow[`visible = 1][`name = \"bla\"`]'
+          #
+          #   # containing predicate. `$` is the mark.
+          #   # Require appium-xcuitest-driver 2.54.0+
+          #   # PR: https://github.com/facebook/WebDriverAgent/pull/707/files
+          #   find_elements :class_chain, 'XCUIElementTypeWindow[$name = \"bla$$$bla\"$]'
+          #   e = find_element :class_chain, "**/XCUIElementTypeWindow[$name == 'Buttons'$]"
+          #   e.tag_name #=> "XCUIElementTypeWindow"
+          #   e = find_element :class_chain, "**/XCUIElementTypeStaticText[$name == 'Buttons'$]"
+          #   e.tag_name #=> "XCUIElementTypeStaticText"
+          #
+          def self.extend
+            ::Appium::Core::Base::SearchContext.add_finders(class_chain: '-ios class chain')
+          end
+        end
+      end # class << self
+    end # module Ios
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/ios_xcuitest.rb

@@ -0,0 +1,8 @@
+# loaded in common/driver.rb
+require_relative 'ios/search_context'
+require_relative 'ios/device'
+require_relative 'ios/touch'
+
+require_relative 'ios/xcuitest/search_context'
+require_relative 'ios/xcuitest/device'
+require_relative 'ios/xcuitest/bridge'

data/lib/appium_lib_core/patch.rb

@@ -0,0 +1,78 @@
+# rubocop:disable Style/ClassAndModuleChildren
+module Appium
+  module Core
+    # Implement useful features for element.
+    # Patch for Selenium Webdriver.
+    class Selenium::WebDriver::Element
+      # Note: For testing .text should be used over value, and name.
+
+      # Returns the value attribute
+      #
+      # Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element for iOS
+      # @return [String]
+      #
+      # @example
+      #
+      #   e = @driver.find_element :accessibility_id, 'something'
+      #   e.value
+      #
+      def value
+        attribute :value
+      end
+
+      # Returns the name attribute
+      #
+      # Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element for iOS
+      # @return [String]
+      #
+      # @example
+      #
+      #   e = @driver.find_element :accessibility_id, 'something'
+      #   e.name
+      #
+      def name
+        attribute :name
+      end
+
+      # Enable access to iOS accessibility label
+      # accessibility identifier is supported as 'name'
+      # @return [String]
+      #
+      # @example
+      #
+      #   e = @driver.find_element :accessibility_id, 'something'
+      #   e.label
+      #
+      def label
+        attribute :label
+      end
+
+      # Alias for type
+      alias type send_keys
+
+      # For use with location_rel.
+      #
+      # @return [::Selenium::WebDriver::Point] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 }
+      #
+      # @example
+      #
+      #   e = @driver.find_element :accessibility_id, 'something'
+      #   e.location_rel @driver
+      #
+      def location_rel(driver)
+        rect = self.rect
+        location_x = rect.x.to_f
+        location_y = rect.y.to_f
+
+        size_width  = rect.width.to_f
+        size_height = rect.height.to_f
+
+        center_x = location_x + (size_width / 2.0)
+        center_y = location_y + (size_height / 2.0)
+
+        w = driver.window_size
+        ::Selenium::WebDriver::Point.new "#{center_x} / #{w.width.to_f}", "#{center_y} / #{w.height.to_f}"
+      end
+    end
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/version.rb

@@ -0,0 +1,6 @@
+module Appium
+  module Core
+    VERSION = '0.1.0'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2017-11-04'.freeze unless defined? ::Appium::Core::DATE
+  end
+end

metadata

@@ -0,0 +1,262 @@
+--- !ruby/object:Gem::Specification
+name: appium_lib_core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuaki MATSUO
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appium_thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+description: Minimal Ruby library for Appium.
+email:
+- fly.49.89.over@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Thorfile
+- appium_lib_core.gemspec
+- bin/console
+- bin/setup
+- lib/appium_lib_core.rb
+- lib/appium_lib_core/android.rb
+- lib/appium_lib_core/android/device.rb
+- lib/appium_lib_core/android/espresso/bridge.rb
+- lib/appium_lib_core/android/search_context.rb
+- lib/appium_lib_core/android/touch.rb
+- lib/appium_lib_core/android/uiautomator1/bridge.rb
+- lib/appium_lib_core/android/uiautomator2/bridge.rb
+- lib/appium_lib_core/android_espresso.rb
+- lib/appium_lib_core/android_uiautomator2.rb
+- lib/appium_lib_core/common.rb
+- lib/appium_lib_core/common/base.rb
+- lib/appium_lib_core/common/base/bridge.rb
+- lib/appium_lib_core/common/base/capabilities.rb
+- lib/appium_lib_core/common/base/command.rb
+- lib/appium_lib_core/common/base/driver.rb
+- lib/appium_lib_core/common/base/http_default.rb
+- lib/appium_lib_core/common/base/search_context.rb
+- lib/appium_lib_core/common/base/wait.rb
+- lib/appium_lib_core/common/command.rb
+- lib/appium_lib_core/common/device.rb
+- lib/appium_lib_core/common/error.rb
+- lib/appium_lib_core/common/log.rb
+- lib/appium_lib_core/common/logger.rb
+- lib/appium_lib_core/device/multi_touch.rb
+- lib/appium_lib_core/device/touch_actions.rb
+- lib/appium_lib_core/driver.rb
+- lib/appium_lib_core/ios.rb
+- lib/appium_lib_core/ios/device.rb
+- lib/appium_lib_core/ios/search_context.rb
+- lib/appium_lib_core/ios/touch.rb
+- lib/appium_lib_core/ios/uiautomation/bridge.rb
+- lib/appium_lib_core/ios/uiautomation/patch.rb
+- lib/appium_lib_core/ios/xcuitest/bridge.rb
+- lib/appium_lib_core/ios/xcuitest/device.rb
+- lib/appium_lib_core/ios/xcuitest/search_context.rb
+- lib/appium_lib_core/ios_xcuitest.rb
+- lib/appium_lib_core/patch.rb
+- lib/appium_lib_core/version.rb
+- release_notes.md
+homepage: https://github.com/appium/ruby_lib
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Minimal Ruby library for Appium.
+test_files: []