simctl 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6635536bf1201eecc5a7d3cb2d1fe2fb5d721c5
-  data.tar.gz: 4338fb14eb475704726f77f953e44901cbb37445
+  metadata.gz: bd28b66b86819a39b9b4c3255d8a43da5a396aa4
+  data.tar.gz: 6701555feb0245c7829b3d19164cf6104aca4091
 SHA512:
-  metadata.gz: e9ad3a1a41451f6c4ef4116bef1b642f1fa5e6a976772863a531245fe87b6262ef97244d71330af272b76d0e42fa4b74338299f7af861f2e7b2d67d4b9d7e119
-  data.tar.gz: ad8334027670d916726a43dc393716ece45ed255473e2a3d249f694dd808407c8c13a54fb702a1453dfb2c5a951b7d89b1d9b4de55620e6c1836370b5013322a
+  metadata.gz: c97dd6ebdc1afef17375c02f98aab4c139767607295a1423ae725e0c461e815020002afe7c5cbfc9f7219457db71acf8d684920451b6f4d04a51b915eea335a6
+  data.tar.gz: 92c109f84dbcae8beb6af57a1561d56f2c239458d80d42581ae906b13e2aaa497c9e37e04c34b1c76376c8ea0981e5851eab3bd5d0743fc3f8a50951730a7f25

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simctl (1.0.2)
+    simctl (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,151 +2,44 @@
 
 [![Build Status](https://travis-ci.org/plu/simctl.svg?branch=master)](https://travis-ci.org/plu/simctl) [![Gem Version](https://badge.fury.io/rb/simctl.svg)](https://badge.fury.io/rb/simctl) [![Coverage Status](https://coveralls.io/repos/plu/simctl/badge.svg?branch=master&service=github)](https://coveralls.io/github/plu/simctl?branch=master)
 
-Ruby interface to xcrun simctl.
-
-## Installation
-
-Via [bundler](http://getbundler.com)
-
-```sh
-# in your Gemfile
-gem 'simctl'
-```
+Ruby interface to xcrun simctl. Manage your iOS Simulators directly from a ruby script. This can be helpful for testing on different Simulators, see example project here: [plu/parallel_ios_tests](https://github.com/plu/parallel_ios_tests)
 
 ## Usage
 
-### boot_device
-
-```ruby
-device = SimCtl.device(name: 'my iphone 5', state: 'Shutdown')
-SimCtl.boot_device(device)
-
-# or:
-
-SimCtl.device(name: 'my iphone 5', state: 'Shutdown').boot!
-```
-
-### create_device
-
-```ruby
-SimCtl.create_device 'my iphone 5', SimCtl.devicetype(name: 'iPhone 5'), SimCtl.runtime(name: 'iOS 9.2')
-
-#<SimCtl::Device:0x007fbce48afd88 @state="Creating", @availability="(available)", @name="my iphone 5", @udid="6F7269E0-6375-4B72-8451-F2728BF6DA82", @os="iOS 9.2">
-```
-
-### delete_device
-
-```ruby
-device = SimCtl.device(name: 'my iphone 5', state: 'Booted')
-SimCtl.delete_device(device)
-
-# or:
-
-SimCtl.device(name: 'my iphone 5', state: 'Booted').delete!
-```
-
-### devicetype
-
-```ruby
-SimCtl.devicetype(name: 'iPhone 5')
-
-#<SimCtl::DeviceType:0x007fd90dd9f2e0 @name="iPhone 5", @identifier="com.apple.CoreSimulator.SimDeviceType.iPhone-5">
-```
-
-### device
-
 ```ruby
-SimCtl.device(name: 'my iphone 5', state: 'Booted')
+require 'simctl'
 
-#<SimCtl::Device:0x007fd90dcce910 @state="Booted", @availability="(available)", @name="my iphone 5", @udid="6F7269E0-6375-4B72-8451-F2728BF6DA82", @os="iOS 9.2">
-```
+# Select the iOS 9.2 runtime
+runtime = SimCtl.runtime(name: 'iOS 9.2')
 
-### erase_device
+# Select the iPhone 5 device type
+devicetype = SimCtl.devicetype(name: 'iPhone 5')
 
-```ruby
-device = SimCtl.device(name: 'my iphone 5', state: 'Booted')
-SimCtl.erase_device(device)
+# Create a new device
+device = SimCtl.create_device 'Unit Tests @ iPhone 5 9.2', devicetype, runtime
 
-# or:
+# Launch a new Simulator.app instance
+device.launch!
 
-SimCtl.device(name: 'my iphone 5', state: 'Booted').erase!
-```
+# Wait for the device to be booted
+device.wait! {|d| d.state == :booted}
 
-### list_devices
+# Kill the Simulator.app instance again
+device.kill!
 
-```ruby
-SimCtl.list_devices.each do |device|
-  puts device.inspect
-end
+# Wait until it did shutdown
+device.wait! {|d| d.state == :shutdown}
 
-#<SimCtl::Device:0x007fd90dd06f90 @state="Booted", @availability="(available)", @name="iPhone 5", @udid="25AC234A-EB91-46EF-9BCB-B7405813EF93", @os="iOS 9.2">
-#<SimCtl::Device:0x007fd90dd06e00 @state="Shutdown", @availability="(available)", @name="iPhone 5", @udid="CEFEDED6-94C0-4B6B-8ABC-B855C49F06B0", @os="iOS 9.2">
+# Delete the device
+device.delete!
 ```
 
-### list_devicetypes
+## License (MIT)
 
-```ruby
-SimCtl.list_devicetypes.each do |devicetype|
-  puts devicetype.inspect
-end
-
-#<SimCtl::DeviceType:0x007fbce48f5270 @name="iPhone 4s", @identifier="com.apple.CoreSimulator.SimDeviceType.iPhone-4s">
-#<SimCtl::DeviceType:0x007fbce48f51f8 @name="iPhone 5", @identifier="com.apple.CoreSimulator.SimDeviceType.iPhone-5">
-#<SimCtl::DeviceType:0x007fbce48f5180 @name="iPhone 5s", @identifier="com.apple.CoreSimulator.SimDeviceType.iPhone-5s">
-#<SimCtl::DeviceType:0x007fbce48f5108 @name="iPhone 6", @identifier="com.apple.CoreSimulator.SimDeviceType.iPhone-6">
-#<SimCtl::DeviceType:0x007fbce48f5090 @name="iPhone 6 Plus", @identifier="com.apple.CoreSimulator.SimDeviceType.iPhone-6-Plus">
-#<SimCtl::DeviceType:0x007fbce48f5018 @name="iPhone 6s", @identifier="com.apple.CoreSimulator.SimDeviceType.iPhone-6s">
-#<SimCtl::DeviceType:0x007fbce48f4fa0 @name="iPhone 6s Plus", @identifier="com.apple.CoreSimulator.SimDeviceType.iPhone-6s-Plus">
-#<SimCtl::DeviceType:0x007fbce48f4f28 @name="iPad 2", @identifier="com.apple.CoreSimulator.SimDeviceType.iPad-2">
-#<SimCtl::DeviceType:0x007fbce48f4eb0 @name="iPad Retina", @identifier="com.apple.CoreSimulator.SimDeviceType.iPad-Retina">
-#<SimCtl::DeviceType:0x007fbce48f4e38 @name="iPad Air", @identifier="com.apple.CoreSimulator.SimDeviceType.iPad-Air">
-#<SimCtl::DeviceType:0x007fbce48f4dc0 @name="iPad Air 2", @identifier="com.apple.CoreSimulator.SimDeviceType.iPad-Air-2">
-#<SimCtl::DeviceType:0x007fbce48f4d48 @name="iPad Pro", @identifier="com.apple.CoreSimulator.SimDeviceType.iPad-Pro">
-#<SimCtl::DeviceType:0x007fbce48f4cd0 @name="Apple TV 1080p", @identifier="com.apple.CoreSimulator.SimDeviceType.Apple-TV-1080p">
-#<SimCtl::DeviceType:0x007fbce48f4c58 @name="Apple Watch - 38mm", @identifier="com.apple.CoreSimulator.SimDeviceType.Apple-Watch-38mm">
-#<SimCtl::DeviceType:0x007fbce48f4be0 @name="Apple Watch - 42mm", @identifier="com.apple.CoreSimulator.SimDeviceType.Apple-Watch-42mm">
-```
-
-### list_runtimes
-
-```ruby
-SimCtl.list_runtimes.each do |runtime|
-  puts runtime.inspect
-end
-
-#<SimCtl::Runtime:0x007fbce48cd6d0 @buildversion="12B411", @availability="(available)", @name="iOS 8.1", @identifier="com.apple.CoreSimulator.SimRuntime.iOS-8-1", @version="8.1">
-#<SimCtl::Runtime:0x007fbce48cd5e0 @buildversion="12D508", @availability="(available)", @name="iOS 8.2", @identifier="com.apple.CoreSimulator.SimRuntime.iOS-8-2", @version="8.2">
-#<SimCtl::Runtime:0x007fbce48cd4f0 @buildversion="12F70", @availability="(available)", @name="iOS 8.3", @identifier="com.apple.CoreSimulator.SimRuntime.iOS-8-3", @version="8.3">
-#<SimCtl::Runtime:0x007fbce48cd400 @buildversion="12H141", @availability="(available)", @name="iOS 8.4", @identifier="com.apple.CoreSimulator.SimRuntime.iOS-8-4", @version="8.4">
-#<SimCtl::Runtime:0x007fbce48cd310 @buildversion="13A344", @availability="(available)", @name="iOS 9.0", @identifier="com.apple.CoreSimulator.SimRuntime.iOS-9-0", @version="9.0">
-#<SimCtl::Runtime:0x007fbce48cd220 @buildversion="13C75", @availability="(available)", @name="iOS 9.2", @identifier="com.apple.CoreSimulator.SimRuntime.iOS-9-2", @version="9.2">
-#<SimCtl::Runtime:0x007fbce48cd130 @buildversion="13U78", @availability="(available)", @name="tvOS 9.1", @identifier="com.apple.CoreSimulator.SimRuntime.tvOS-9-1", @version="9.1">
-#<SimCtl::Runtime:0x007fbce48cd040 @buildversion="13S660", @availability="(available)", @name="watchOS 2.1", @identifier="com.apple.CoreSimulator.SimRuntime.watchOS-2-1", @version="2.1">
-```
+Copyright (C) 2016 Johannes Plunien
 
-### reset_device
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-```ruby
-SimCtl.reset_device 'my iphone 5', SimCtl.devicetype(name: 'iPhone 5'), SimCtl.runtime(name: 'iOS 9.2')
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-#<SimCtl::Device:0x007fbce48afd88 @state="Creating", @availability="(available)", @name="my iphone 5", @udid="6F7269E0-6375-4B72-8451-F2728BF6DA82", @os="iOS 9.2">
-```
-
-### runtime
-
-```ruby
-SimCtl.runtime(name: 'iOS 9.2')
-
-#<SimCtl::Runtime:0x007fd90dd2da28 @buildversion="13C75", @availability="(available)", @name="iOS 9.2", @identifier="com.apple.CoreSimulator.SimRuntime.iOS-9-2", @version="9.2">
-```
-
-### shutdown_device
-
-```ruby
-device = SimCtl.device(name: 'my iphone 5', state: 'Booted')
-SimCtl.shutdown_device(device)
-
-# or:
-
-SimCtl.device(name: 'my iphone 5', state: 'Booted').shutdown!
-```
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/simctl/command.rb

@@ -5,6 +5,7 @@ require 'simctl/command/erase'
 require 'simctl/command/kill'
 require 'simctl/command/launch'
 require 'simctl/command/list'
+require 'simctl/command/reset'
 require 'simctl/command/shutdown'
 require 'simctl/executor'
 
@@ -17,6 +18,7 @@ module SimCtl
     include SimCtl::Command::Kill
     include SimCtl::Command::Launch
     include SimCtl::Command::List
+    include SimCtl::Command::Reset
     include SimCtl::Command::Shutdown
   end
 end

data/lib/simctl/command/create.rb

@@ -14,26 +14,6 @@ module SimCtl
           device(udid: identifier)
         end
       end
-
-      # Shutdown, delete and create a device
-      #
-      # @param name [String] name of the new device
-      # @param device_type [SimCtl::DeviceType] device type of the new device
-      # @param runtime [SimCtl::Runtime] runtime of the new device
-      # @return [SimCtl::Device] the device that was created
-      # @yield [exception] an exception that might happen during shutdown/delete of the old device
-      def reset_device(name, device_type, runtime)
-        begin
-          list_devices.where(name: name, os: runtime.name).each do |device|
-            device.kill!
-            device.shutdown! if device.state != 'Shutdown'
-            device.delete!
-          end
-        rescue Exception => exception
-          yield exception if block_given?
-        end
-        create_device name, device_type, runtime
-      end
     end
   end
 end

data/lib/simctl/command/reset.rb

@@ -0,0 +1,26 @@
+module SimCtl
+  class Command
+    module Reset
+      # Kill, shutdown, delete and create a device
+      #
+      # @param name [String] name of the new device
+      # @param device_type [SimCtl::DeviceType] device type of the new device
+      # @param runtime [SimCtl::Runtime] runtime of the new device
+      # @return [SimCtl::Device] the device that was created
+      # @yield [exception] an exception that might happen during shutdown/delete of the old device
+      def reset_device(name, device_type, runtime)
+        begin
+          list_devices.where(name: name, os: runtime.name).each do |device|
+            device.kill!
+            device.shutdown! if device.state != :shutdown
+            device.wait! {|d| d.state == :shutdown}
+            device.delete!
+          end
+        rescue Exception => exception
+          yield exception if block_given?
+        end
+        create_device name, device_type, runtime
+      end
+    end
+  end
+end

data/lib/simctl/device.rb

@@ -1,20 +1,18 @@
 require 'simctl/object'
+require 'timeout'
 
 module SimCtl
   class Device < Object
     attr_reader :availability, :name, :os, :state, :udid
 
-    # Boot the device
     def boot!
       SimCtl.boot_device(self)
     end
 
-    # Delete the device
     def delete!
       SimCtl.delete_device(self)
     end
 
-    # Erase the device
     def erase!
       SimCtl.erase_device(self)
     end
@@ -27,9 +25,20 @@ module SimCtl
       SimCtl.launch_device(self)
     end
 
-    # Shutdown the device
     def shutdown!
       SimCtl.shutdown_device(self)
     end
+
+    def state
+      @state.downcase.to_sym
+    end
+
+    def wait!(timeout=15)
+      Timeout::timeout(timeout) do
+        loop do
+          break if yield SimCtl.device(udid: udid)
+        end
+      end
+    end
   end
 end

data/lib/simctl/version.rb

@@ -1,3 +1,3 @@
 module SimCtl
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/test/simctl/command/crud_test.rb

@@ -1,31 +1,22 @@
 require 'securerandom'
 require 'test_helper'
-require 'timeout'
 
 class SimCtl::Command::CRUDTest < Minitest::Test
   def setup
     @devicetype = SimCtl.list_devicetypes.select {|devicetype| devicetype.name =~ %r[iPhone]}.first
     @runtime = SimCtl.list_runtimes.select {|runtime| runtime.name =~ %r[iOS.*9]}.first
     @device = SimCtl.create_device SecureRandom.hex, @devicetype, @runtime
-    wait_for {|device| device.state != 'Creating'}
+    @device.wait! {|device| device.state != :creating}
   end
 
   def teardown
     device = SimCtl.device(udid: @device.udid)
     return unless device
-    device.shutdown! if device.state != 'Shutdown'
+    device.kill!
+    device.shutdown! if device.state != :shutdown
     device.delete!
   end
 
-  def wait_for
-    Timeout::timeout(30) do
-      loop do
-        device = SimCtl.device(udid: @device.udid)
-        break if yield device
-      end
-    end
-  end
-
   should 'find the device created in setup' do
     device = SimCtl.device(udid: @device.udid)
     assert_kind_of SimCtl::Device, device
@@ -36,6 +27,13 @@ class SimCtl::Command::CRUDTest < Minitest::Test
     assert device.udid != nil
   end
 
+  should 'launch and kill the device created in setup' do
+    device = SimCtl.device(udid: @device.udid)
+    assert device.launch!
+    device.wait!{|device| device.state == :booted}
+    assert device.kill!
+  end
+
   should 'erase the device created in setup' do
     device = SimCtl.device(udid: @device.udid)
     SimCtl.erase_device device
@@ -44,9 +42,9 @@ class SimCtl::Command::CRUDTest < Minitest::Test
   should 'boot/shutdown the device created in setup' do
     device = SimCtl.device(udid: @device.udid)
     SimCtl.boot_device device
-    wait_for {|device| device.state == 'Booted'}
+    device.wait! {|device| device.state == :booted}
     SimCtl.shutdown_device device
-    wait_for {|device| device.state == 'Shutdown'}
+    device.wait! {|device| device.state == :shutdown}
   end
 
   should 'delete the device created in setup' do
@@ -60,6 +58,6 @@ class SimCtl::Command::CRUDTest < Minitest::Test
     assert_kind_of SimCtl::Device, device
     assert_nil SimCtl.device(udid: @device.udid)
     @device = device # teardown cleanup
-    wait_for {|device| device.state != 'Creating'}
+    device.wait! {|device| device.state != :creating}
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simctl
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Johannes Plunien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -90,6 +90,7 @@ files:
 - lib/simctl/command/kill.rb
 - lib/simctl/command/launch.rb
 - lib/simctl/command/list.rb
+- lib/simctl/command/reset.rb
 - lib/simctl/command/shutdown.rb
 - lib/simctl/device.rb
 - lib/simctl/device_type.rb