Allow to name toml files differently than appium.txt, fixes #280 (#397)

* Allow to name toml files differently than appium.txt, fixes #280

* rename load_appium_txt to load_settings and split it in 2 methods

* rubocop rule violation fixed

Author: KazuCocoa

android_tests/lib/android/specs/driver.rb

@@ -6,9 +6,9 @@ def sauce?
     ENV['UPLOAD_FILE'] && ENV['SAUCE_USERNAME']
   end
 
-  t 'load_appium_txt' do
-    appium_txt = File.expand_path(File.join(Dir.pwd, 'lib'))
-    parsed   = Appium.load_appium_txt file: appium_txt, verbose: true
+  t 'load_settings' do
+    appium_txt = File.join(Dir.pwd, 'appium.txt')
+    parsed   = Appium.load_settings file: appium_txt, verbose: true
     apk_name = File.basename parsed[:caps][:app]
     assert_equal apk_name, 'api.apk'
   end

android_tests/lib/run.rb

@@ -21,16 +21,16 @@ def start_driver(caps)
 a = OpenStruct.new x: 'ok'
 fail 'x issue' unless a.x == 'ok'
 
-appium_txt  = File.expand_path(File.join(Dir.pwd, 'lib'))
-dir     = appium_txt
+dir  = File.expand_path(File.join(Dir.pwd, 'lib'))
+appium_txt = File.join(Dir.pwd, 'appium.txt')
 device  = ARGV[0].downcase.strip
 devices = %w(android selendroid ios)
 fail 'Expected android, selendroid or ios as first argument' unless devices.include? device
 
 one_test = ARGV[1]
 test_dir = "/#{device}/"
 
-caps       = Appium.load_appium_txt file: appium_txt, verbose: true
+caps       = Appium.load_settings file: appium_txt, verbose: true
 caps       = caps.merge(appium_lib: { debug: true, wait: 1 })
 caps[:app] = ENV['SAUCE_PATH'] if ENV['SAUCE_USERNAME'] && ENV['SAUCE_ACCESS_KEY']
 

ios_tests/lib/ios/specs/driver.rb

@@ -17,12 +17,12 @@ def sauce?
     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]

lib/appium_lib/driver.rb

@@ -51,7 +51,6 @@ class Spec < Test
 
 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 @@ def self.load_appium_txt(opts = {})
       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 @@ def self.absolute_app_path(opts)
       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