run_loop 2.5.3 → 2.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df4249f36fc6ecabe9284a3065e9a46e03db5a5c
-  data.tar.gz: 05ffd2992c349738d98fd054dac29423b969eab0
+  metadata.gz: 975468eda0e5cfb4d2432722651b202e8ec800a8
+  data.tar.gz: bf3695bf51d10dbaf295eb34d7b727da45e7996d
 SHA512:
-  metadata.gz: fc3f2c96a9815ffe86ffc18afdc03aa3dc986d224b6c8255f54d4e409ce9164659508e648b7a327111f33d30904127634282c86a2469143b8598dd11384a3549
-  data.tar.gz: 5a2c62019f91ffc015d7fae3fc256e918070598d0513a48f387f92ac7045efa604e70a772e304dc6e535bd7444cf18b193bce493ba5d9fb7624c2a706fbd0b4f
+  metadata.gz: bf3e3ab2e48f2754cb71d616e19f3a30d02d4d6749b1b471a0cf903318cd57b2d393badc75fc5d1664145755e9f584a2e0d898ea2cbfacda56bb6b590a0a1e33
+  data.tar.gz: 80b1520a789b6998204ff8137a80a26a0fbf9df37da7d7d978422a7562f16eaaca3acc4c727671f7d39f4ef57d48414617b666c279405d8cc8e89d0b7fd1c92a

data/lib/run_loop/device.rb

@@ -275,79 +275,44 @@ version: #{version}
 
     # @!visibility private
     def simulator_root_dir
-      @simulator_root_dir ||= lambda {
-        return nil if physical_device?
-        File.join(CORE_SIMULATOR_DEVICE_DIR, udid)
-      }.call
+      return nil if physical_device?
+      @simulator_root_dir ||= File.join(CORE_SIMULATOR_DEVICE_DIR, udid)
     end
 
     # @!visibility private
     def simulator_accessibility_plist_path
-      @simulator_accessibility_plist_path ||= lambda {
-        return nil if physical_device?
-        File.join(simulator_root_dir, 'data/Library/Preferences/com.apple.Accessibility.plist')
-      }.call
+      return nil if physical_device?
+
+      directory = File.join(simulator_root_dir, "data", "Library", "Preferences")
+      pbuddy.ensure_plist(directory, "com.apple.Accessibility.plist")
     end
 
     # @!visibility private
     def simulator_preferences_plist_path
       return nil if physical_device?
 
-
       directory = File.join(simulator_root_dir, "data", "Library", "Preferences")
-
-      if !File.exist?(directory)
-        FileUtils.mkdir_p(directory)
-      end
-
-      plist = File.join(directory, "com.apple.Preferences.plist")
-
-      if !File.exist?(plist)
-        pbuddy.create_plist(plist)
-      end
-      plist
+      pbuddy.ensure_plist(directory, "com.apple.Preferences.plist")
     end
 
     # @!visibility private
     def simulator_log_file_path
-      @simulator_log_file_path ||= lambda {
-        return nil if physical_device?
-        File.join(CORE_SIMULATOR_LOGS_DIR, udid, 'system.log')
-      }.call
+      return nil if physical_device?
+      @simulator_log_file_path ||= File.join(CORE_SIMULATOR_LOGS_DIR, udid,
+                                             'system.log')
     end
 
     # @!visibility private
     def simulator_device_plist
-      @simulator_device_plist ||= lambda do
-        return nil if physical_device?
-        File.join(simulator_root_dir, 'device.plist')
-      end.call
+      return nil if physical_device?
+      pbuddy.ensure_plist(simulator_root_dir, "device.plist")
     end
 
     # @!visibility private
-    def simulator_global_preferences_path(timeout=10)
+    def simulator_global_preferences_path
       return nil if physical_device?
-
-      path = File.join(simulator_root_dir,
-                       "data/Library/Preferences/.GlobalPreferences.plist")
-
-      return path if File.exist?(path)
-
-      start = Time.now
-      while !File.exist?(path) && (start + timeout) < Time.now
-        sleep(1.0)
-      end
-
-      return path if File.exist?(path)
-
-      raise(RuntimeError, %Q[
-Timed out waiting for .GlobalPreferences.plist after #{Time.now - start} seconds.
-
-File does not exist at path:
-
-#{path}
-
-])
+      directory = File.join(simulator_root_dir, "data", "Library", "Preferences")
+      pbuddy.ensure_plist(directory, ".GlobalPreferences.plist")
     end
 
     # @!visibility private
@@ -474,25 +439,14 @@ File does not exist at path:
 
       global_plist = simulator_global_preferences_path
 
-      cmd = [
-        "/usr/libexec/PlistBuddy",
-        "-c",
-        "Add :AppleLanguages:0 string '#{lang_code}'",
-        global_plist
-      ]
-
-      # RunLoop::PlistBuddy cannot add items to arrays.
-      hash = run_shell_command(cmd, {:log_cmd => true})
-
-      if hash[:exit_status] != 0
+      begin
+        pbuddy.unshift_array("AppleLanguages", "string", lang_code,
+                             global_plist)
+      rescue RuntimeError => e
         raise RuntimeError, %Q[
-Could not update the Simulator languages because this command:
-
-#{cmd.join(" ")}
-
-failed with this output:
+Could not update the Simulator languages.
 
-#{hash[:out]}
+#{e.message}
 
 ]
       end

data/lib/run_loop/plist_buddy.rb

@@ -1,3 +1,4 @@
+
 module RunLoop
   # A class for reading and writing property list values.
   #
@@ -6,6 +7,11 @@ module RunLoop
   # is problematic for our purposes.
   class PlistBuddy
 
+    require "fileutils"
+    require "run_loop/shell"
+
+    include RunLoop::Shell
+
     # Reads key from file and returns the result.
     # @param [String] key the key to inspect (may not be nil or empty)
     # @param [String] file the plist to read
@@ -18,11 +24,11 @@ module RunLoop
         raise(ArgumentError, "key '#{key}' must not be nil or empty")
       end
       cmd = build_plist_cmd(:print, {:key => key}, file)
-      res = execute_plist_cmd(cmd, opts)
-      if res == "Print: Entry, \":#{key}\", Does Not Exist"
+      success, output = execute_plist_cmd(cmd, file, opts)
+      if !success
         nil
       else
-        res
+        output
       end
     end
 
@@ -64,8 +70,16 @@ module RunLoop
         cmd = build_plist_cmd(:add, cmd_args, file)
       end
 
-      res = execute_plist_cmd(cmd, merged)
-      res == ''
+      success, output = execute_plist_cmd(cmd, file, merged)
+      if !success
+        raise RuntimeError, %Q[
+Encountered an error performing operation on plist:
+
+#{plist_buddy} -c "#{cmd}" #{file}
+=> #{output}
+]
+      end
+      success
     end
 
     # Creates an new empty plist at `path`.
@@ -85,6 +99,78 @@ module RunLoop
       path
     end
 
+    # Ensures a plist exists at path by creating necessary directories and
+    # creating an empty plist if none exists.
+    def ensure_plist(directory, name)
+      FileUtils.mkdir_p(directory) if !File.exist?(directory)
+
+      plist = File.join(directory, name)
+
+      create_plist(plist) if !File.exists?(plist)
+
+      plist
+    end
+
+    # Sends an arbitrary command (-c) to PlistBuddy.
+    #
+    # This class does not handle setting data, date, dictionary, or array
+    # or manipulating elements in existing array or dictionary types.  This
+    # method is an attempt to bridge this gap.
+    #
+    # When setting/adding bool, real, integer, string values, use #plist_set.
+    #
+    # For reading values, use #plist_read.
+    #
+    # @param [String] cmd The command passed to PlistBuddy with -c
+    # @param [String] file Path the plist file
+    # @param [Hash] opts options for controlling execution
+    # @option opts [Boolean] :verbose (false) controls log level
+    # @raise RuntimeError when running the command fails.
+    # @return Boolean, String Success and the output of running the command.
+    def run_command(cmd, file, opts={})
+      success, output = execute_plist_cmd(cmd, file, opts)
+      if !success
+        raise RuntimeError, %Q[
+Encountered an error performing operation on plist:
+
+#{plist_buddy} -c "#{cmd}" #{file}
+=> #{output}
+]
+      end
+      return success, output
+    end
+
+    # Add value to the head of an array type.
+    #
+    # @param [String] key The plist key
+    # @param [String] type any allowed plist type
+    # @param [Object] value the value to add
+    # @param [String] path the plist path
+    # @param [Hash] opts options for controlling execution
+    # @option opts [Boolean] :verbose (false) controls log level
+    # @raise RuntimeError when running the command fails.
+    # @raise RuntimeError if attempt to push value onto non-array container.
+    def unshift_array(key, type, value, path, opts={})
+      if !plist_key_exists?(key, path)
+        run_command("Add :#{key} array", path, opts)
+      else
+        key_type = plist_read(key, path).split(" ")[0]
+        if key_type != "Array"
+          raise RuntimeError, %Q[
+Could not push #{value} onto array:
+  Expected:  key #{key} be of type Array
+     Found:  had type #{key_type}
+
+in plist:
+
+  #{path}
+]
+        end
+      end
+
+      run_command("Add :#{key}:0 #{type} #{value}", path, opts)
+    end
+
     private
 
     # returns the path to the PlistBuddy executable
@@ -101,24 +187,17 @@ module RunLoop
     # @return [Boolean,String] `true` if command was successful.  If :print'ing
     #  the result, the value of the key.  If there is an error, the output of
     #  stderr.
-    def execute_plist_cmd(cmd, opts={})
-      default_opts = {:verbose => false}
+    def execute_plist_cmd(cmd, file, opts={})
+      default_opts = {:verbose => false }
       merged = default_opts.merge(opts)
 
-      puts cmd if merged[:verbose]
+      merged[:log_cmd] = merged[:verbose]
 
-      res = nil
-      # noinspection RubyUnusedLocalVariable
-      Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
-        err = stderr.read
-        std = stdout.read
-        if not err.nil? and err != ''
-          res = err.chomp
-        else
-          res = std.chomp
-        end
-      end
-      res
+      args = [plist_buddy, "-c", cmd, file]
+
+      hash = run_shell_command(args, merged)
+
+      return hash[:exit_status] == 0, hash[:out]
     end
 
     # Composes a PlistBuddy command that can be executed as a shell command.
@@ -161,13 +240,13 @@ module RunLoop
           unless key
             raise(ArgumentError, ':key is a required key for :add command')
           end
-          cmd_part = "\"Add :#{key} #{value_type} #{value}\""
+          cmd_part = "Add :#{key} #{value_type} #{value}"
         when :print
           key = args_hash[:key]
           unless key
             raise(ArgumentError, ':key is a required key for :print command')
           end
-          cmd_part = "\"Print :#{key}\""
+          cmd_part = "Print :#{key}"
         when :set
           value = args_hash[:value]
           unless value
@@ -177,13 +256,13 @@ module RunLoop
           unless key
             raise(ArgumentError, ':key is a required key for :set command')
           end
-          cmd_part = "\"Set :#{key} #{value}\""
+          cmd_part = "Set :#{key} #{value}"
         else
           cmds = [:add, :print, :set]
           raise(ArgumentError, "expected '#{type}' to be one of '#{cmds}'")
       end
 
-      "#{plist_buddy} -c #{cmd_part} \"#{file}\""
+      cmd_part
     end
   end
 end

data/lib/run_loop/simctl.rb

@@ -24,7 +24,7 @@ module RunLoop
       "Shutdown" => 1,
       "Shutting Down" => 2,
       "Booted" => 3,
-      "Plist Missing" => -1
+      "Plist Missing Key" => -1
     }.freeze
 
     # @!visibility private
@@ -125,10 +125,11 @@ module RunLoop
     # @!visibility private
     def simulator_state_as_int(device)
       plist = device.simulator_device_plist
-      if File.exist?(plist)
+
+      if pbuddy.plist_key_exists?("state", plist)
         pbuddy.plist_read("state", plist).to_i
       else
-        SIM_STATES["Plist Missing"]
+        SIM_STATES["Plist Missing Key"]
       end
     end
 

data/lib/run_loop/version.rb

@@ -1,5 +1,5 @@
 module RunLoop
-  VERSION = "2.5.3"
+  VERSION = "2.5.4"
 
   # A model of a software release version that can be used to compare two versions.
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: run_loop
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.5.4
 platform: ruby
 authors:
 - Karl Krukow
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2017-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json