appium_lib 8.1.0 → 8.2.0

data/docs/migration.md

@@ -1,3 +1,26 @@
+### Breaking Changes in 8.2.0
+change `Appium.load_appium_txt` to `Appium.load_settings`.
+
+           Old | New
+            :--|:--
+`Appium.load_appium_txt` | `Appium.load_settings`
+
+- after
+
+```
+dir        = File.expand_path(File.join(Dir.pwd, 'lib'))
+appium_txt = File.join(Dir.pwd, 'appium.txt')
+caps       = Appium.load_settings file: appium_txt, verbose: true
+```
+
+- before
+
+```
+appium_txt = File.expand_path(File.join(Dir.pwd, 'lib'))
+dir        = appium_txt
+caps       = Appium.load_appium_txt file: appium_txt, verbose: true
+```
+
 ### Breaking Changes in 7.0
 
 Requires appium 1.4.0-beta or newer for iOS helper methods. appium_lib no longer automatically promotes methods on minispec. To restore the old behavior use: `Appium.promote_appium_methods ::Minitest::Spec`

data/ios_tests/lib/ios/specs/driver.rb

@@ -17,12 +17,12 @@ describe 'driver' do
     data.strip.must_equal 174.chr('UTF-8')
   end
 
-  t 'load_appium_txt' do
+  t 'load_settings' do
     # skip this test if we're using Sauce
     # the storage API doesn't have an on disk file
     skip if sauce?
-    appium_txt = File.expand_path(File.join(Dir.pwd, 'lib'))
-    opts       = Appium.load_appium_txt file: appium_txt, verbose: true
+    appium_txt = File.join(Dir.pwd, 'appium.txt')
+    opts       = Appium.load_settings file: appium_txt, verbose: true
 
     actual   = ''
     actual   = File.basename opts[:caps][:app] if opts && opts[:caps]

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '8.1.0' unless defined? ::Appium::VERSION
-  DATE    = '2016-11-18' unless defined? ::Appium::DATE
+  VERSION = '8.2.0' unless defined? ::Appium::VERSION
+  DATE    = '2016-11-26' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/device/device.rb

@@ -309,6 +309,7 @@ module Appium
         end
 
         add_touch_actions
+        add_ime_actions
         extend_search_contexts
       end
 
@@ -359,6 +360,29 @@ module Appium
         end
       end
 
+      # @private
+      def add_bridge_method(method)
+        if block_given?
+          create_bridge method, &Proc.new
+        else
+          create_bridge method
+        end
+
+        delegate_driver_method method
+        delegate_from_appium_driver method
+      end
+
+      # @private
+      def create_bridge(method)
+        Selenium::WebDriver::Remote::Bridge.class_eval do
+          if block_given?
+            class_eval(&Proc.new)
+          else
+            define_method(method) { execute method }
+          end
+        end
+      end
+
       # @!method find_element
       # @!method find_elements
       #
@@ -395,6 +419,80 @@ module Appium
         delegate_from_appium_driver(:pinch, Appium::MultiTouch)
         delegate_from_appium_driver(:zoom, Appium::MultiTouch)
       end
+
+      def add_ime_actions
+        # Commands for IME are defined in the following commands.rb, but the driver have no bridge.
+        # So, appium_lib define just bridge here.
+        # https://github.com/SeleniumHQ/selenium/blob/selenium-3.0.1/rb/lib/selenium/webdriver/remote/commands.rb#L184-L192
+
+        # @!method ime_activate
+        #   Make an engine that is available active.
+        #
+        #   Android only.
+        #   @param [String] The IME owning the activity [required]
+        #
+        #   ```ruby
+        #   ime_activate engine: 'com.android.inputmethod.latin/.LatinIME'
+        #   ```
+        add_bridge_method(:ime_activate) do
+          def ime_activate(ime_name)
+            execute :imeActivateEngine, {}, engine: ime_name
+          end
+        end
+
+        # @!method ime_available_engines
+        #   List all available input engines on the machine.
+        #   Android only.
+        #
+        #   ```ruby
+        #   ime_available_engines #=> Get the list of IME installed in the target device
+        #   ```
+        add_bridge_method(:ime_available_engines) do
+          def ime_available_engines
+            execute :imeGetAvailableEngines
+          end
+        end
+
+        # @!method ime_active_engine
+        #   Get the name of the active IME engine.
+        #   Android only.
+        #
+        #   ```ruby
+        #   ime_active_engine #=> Get the current active IME such as 'com.android.inputmethod.latin/.LatinIME'
+        #   ```
+        add_bridge_method(:ime_active_engine) do
+          def ime_active_engine
+            execute :imeGetActiveEngine
+          end
+        end
+
+        # @!method ime_activated
+        #   Indicates whether IME input is active at the moment (not if it is available).
+        #   Android only.
+        #
+        #   ```ruby
+        #   ime_activated #=> True if IME is activated
+        #   ```
+        add_bridge_method(:ime_activated) do
+          def ime_activated
+            execute :imeIsActivated
+          end
+        end
+
+        # @!method ime_deactivate
+        #   De-activates the currently-active IME engine.
+        #
+        #   Android only.
+        #
+        #   ```ruby
+        #   ime_deactivate #=> Deactivate current IME engine
+        #   ```
+        add_bridge_method(:ime_deactivate) do
+          def ime_deactivate
+            execute :imeDeactivate, {}
+          end
+        end
+      end
     end # class << self
 
     # @!method set_context

data/lib/appium_lib/driver.rb

@@ -51,7 +51,6 @@ end
 
 module Appium
   # Load appium.txt (toml format)
-  # the basedir of this file + appium.txt is what's used
   #
   # ```
   # [caps]
@@ -67,17 +66,15 @@ module Appium
   #
   # @param opts [Hash] file: '/path/to/appium.txt', verbose: true
   # @return [hash] the symbolized hash with updated :app and :require keys
-  def self.load_appium_txt(opts = {})
+  def self.load_settings(opts = {})
     fail 'opts must be a hash' unless opts.is_a? Hash
     fail 'opts must not be empty' if opts.empty?
 
-    file = opts[:file]
-    fail 'Must pass file' unless file
+    toml = opts[:file]
+    fail 'Must pass file' unless toml
     verbose = opts.fetch :verbose, false
 
-    parent_dir = File.dirname file
-    toml       = File.expand_path File.join parent_dir, 'appium.txt'
-    Appium::Logger.info "appium.txt path: #{toml}" if verbose
+    Appium::Logger.info "appium settings path: #{toml}" if verbose
 
     toml_exists = File.exist? toml
     Appium::Logger.info "Exists? #{toml_exists}" if verbose
@@ -93,40 +90,47 @@ module Appium
       data[:caps][:app] = Appium::Driver.absolute_app_path data
     end
 
-    # return list of require files as an array
-    # nil if require doesn't exist
     if data && data[:appium_lib] && data[:appium_lib][:require]
-      r = data[:appium_lib][:require]
-      r = r.is_a?(Array) ? r : [r]
-      # ensure files are absolute
-      r.map! do |f|
-        file = File.exist?(f) ? f : File.join(parent_dir, f)
-        file = File.expand_path file
-
-        File.exist?(file) ? file : nil
-      end
-      r.compact! # remove nils
+      parent_dir = File.dirname toml
+      data[:appium_lib][:require] = expand_required_files(parent_dir, data[:appium_lib][:require])
+    end
 
-      files = []
+    data
+  end
 
-      # now expand dirs
-      r.each do |item|
-        unless File.directory? item
-          # save file
-          files << item
-          next # only look inside folders
-        end
-        Dir.glob(File.expand_path(File.join(item, '**', '*.rb'))) do |f|
-          # do not add folders to the file list
-          files << File.expand_path(f) unless File.directory? f
-        end
-      end
+  class << self
+    alias_method :load_appium_txt, :load_settings
+  end
 
-      # Must not sort files. File order is specified in appium.txt
-      data[:appium_lib][:require] = files
+  # @param base_dir [String] parent directory of loaded appium.txt (toml)
+  # @param file_paths
+  # @return list of require files as an array, nil if require doesn't exist
+  def self.expand_required_files(base_dir, file_paths)
+    # ensure files are absolute
+    Array(file_paths).map! do |f|
+      file = File.exist?(f) ? f : File.join(base_dir, f)
+      file = File.expand_path file
+
+      File.exist?(file) ? file : nil
     end
+    r.compact! # remove nils
 
-    data
+    files = []
+
+    # now expand dirs
+    file_paths.each do |item|
+      unless File.directory? item
+        # save file
+        files << item
+        next # only look inside folders
+      end
+      Dir.glob(File.expand_path(File.join(item, '**', '*.rb'))) do |f|
+        # do not add folders to the file list
+        files << File.expand_path(f) unless File.directory? f
+      end
+    end
+
+    files
   end
 
   # convert all keys (including nested) to symbols
@@ -430,7 +434,7 @@ module Appium
       return app_path unless app_path.match(/[\/\\]/)
 
       # relative path that must be expanded.
-      # absolute_app_path is called from load_appium_txt
+      # absolute_app_path is called from load_settings
       # and the txt file path is the base of the app path in that case.
       app_path = File.expand_path app_path
       fail "App doesn't exist #{app_path}" unless File.exist? app_path

data/release_notes.md

@@ -1,6 +1,13 @@
+#### v8.2.0 2016-11-26
+
+- [4535ec9](https://github.com/appium/ruby_lib/commit/4535ec91f435255ae31b4c4fea9d96e5405d79f5) Release 8.2.0
+- [8a08021](https://github.com/appium/ruby_lib/commit/8a080213dbe4843f50b6acfbe80628209bfd143d) add endpoint for handling IME in remote bridge (#400)
+- [222cd47](https://github.com/appium/ruby_lib/commit/222cd47f69ba24b82a122734b0a136e5d6aed330) Allow to name toml files differently than appium.txt, fixes #280 (#397)
+- [d3a9235](https://github.com/appium/ruby_lib/commit/d3a9235767d6ba770246afac0e62ac58da0eb4b0) update release note and documentation (#396)
+
 #### v8.1.0 2016-11-18
 
-- [0b476e7](https://github.com/appium/ruby_lib/commit/0b476e7c78f8cb829a909de55a402c6585ac5159) Release 8.1.0
+- [95d3a65](https://github.com/appium/ruby_lib/commit/95d3a6535472559590c4d043e887d15acc445a1a) Release 8.1.0
 - [6c38ca5](https://github.com/appium/ruby_lib/commit/6c38ca5276342ade6168eb9080424a03608a1b3e) replace end_ to delta_ because end_ is deprecated in #380 (#392)
 - [09654ab](https://github.com/appium/ruby_lib/commit/09654ab9dbc69a31eff7e7bd426db985da09e3b8) Add EventListener to Driver (#389)
 - [2d8fc5f](https://github.com/appium/ruby_lib/commit/2d8fc5ff7acce9417847e66772b59fc691c1dbaa) Added touch id endpoint (#384)
@@ -1272,4 +1279,4 @@
 
 - [01f2d15](https://github.com/appium/ruby_lib/commit/01f2d150ae3d8e88970b361a8330c6ccc174097d) Release 0.0.19
 - [10eec2f](https://github.com/appium/ruby_lib/commit/10eec2f197899395978b73de049aed08ceda55cc) AppLib => AppiumLib
-- [c1e3b4f](https://github.com/appium/ruby_lib/commit/c1e3b4f0a08be3a0aef65218220f09f4198683bf) AppLib => AppiumLib
+- [c1e3b4f](https://github.com/appium/ruby_lib/commit/c1e3b4f0a08be3a0aef65218220f09f4198683bf) AppLib => AppiumLib

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.2.0
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver