Repository: MobileNativeFoundation/set-simulator-location
Branch: main
Commit: b40a1e86b8dc
Files: 19
Total size: 20.7 KB

Directory structure:
gitextract_jedpsxcx/

├── .gitignore
├── .travis.yml
├── CODEOWNERS
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── Package.swift
├── README.md
├── sources/
│   ├── cli.swift
│   ├── coordinate+extension.swift
│   ├── coordinate.swift
│   ├── errors.swift
│   ├── main.swift
│   ├── notification.swift
│   ├── query.swift
│   ├── result.swift
│   ├── simulators.swift
│   └── stderr.swift
└── xcodeproj.xcconfig

================================================
FILE CONTENTS
================================================

================================================
FILE: .gitignore
================================================
.build
.DS_Store
Project.xcodeproj
set-simulator-location
.swiftpm/


================================================
FILE: .travis.yml
================================================
language: objective-c
osx_image: xcode11.5

install: true
script:
  - make


================================================
FILE: CODEOWNERS
================================================
* @keith


================================================
FILE: CONTRIBUTING.md
================================================
## Code of conduct

This project is governed by [Lyft's code of
conduct](https://github.com/lyft/code-of-conduct). All contributors and
participants agree to abide by its terms.

## Contributing

1. Fork the repo.
1. Make your changes
1. Add an entry to the `CHANGELOG.md`
1. Sign our [Contributor License Agreement
   (CLA)](https://oss.lyft.com/cla)
1. Push to your fork and submit a pull request!


================================================
FILE: LICENSE
================================================
                              Apache License
                        Version 2.0, January 2004
                     http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
       that You distribute, all copyright, patent, trademark, and
       attribution notices from the Source form of the Work,
       excluding those notices that do not pertain to any part of
       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
       distribution, then any Derivative Works that You distribute must
       include a readable copy of the attribution notices contained
       within such NOTICE file, excluding those notices that do not
       pertain to any part of the Derivative Works, in at least one
       of the following places: within a NOTICE text file distributed
       as part of the Derivative Works; within the Source form or
       documentation, if provided along with the Derivative Works; or,
       within a display generated by the Derivative Works, if and
       wherever such third-party notices normally appear. The contents
       of the NOTICE file are for informational purposes only and
       do not modify the License. You may add Your own attribution
       notices within Derivative Works that You distribute, alongside
       or as an addendum to the NOTICE text from the Work, provided
       that such additional attribution notices cannot be construed
       as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS


================================================
FILE: Makefile
================================================
EXECUTABLE = set-simulator-location
ARCHIVE = $(EXECUTABLE).tar.gz
PREFIX ?= /usr/local/bin
SRCS = $(wildcard sources/*.swift)

$(EXECUTABLE): $(SRCS)
	swiftc \
		-warnings-as-errors \
		-O -whole-module-optimization \
		-o $(EXECUTABLE) \
		-sdk $(shell xcrun --sdk macosx --show-sdk-path) \
		-target x86_64-macosx10.10 \
		$(SRCS)

.PHONY: install
install: $(EXECUTABLE)
	install $(EXECUTABLE) "$(PREFIX)"

.PHONY: archive
archive: $(EXECUTABLE)
	tar --create --preserve-permissions --gzip --file $(ARCHIVE) $(EXECUTABLE)
	@shasum -a 256 $(EXECUTABLE)
	@shasum -a 256 $(ARCHIVE)

.PHONY: xcode
xcode:
	swift package generate-xcodeproj \
		--xcconfig-overrides xcodeproj.xcconfig \
		--output Project.xcodeproj

.PHONY: clean
clean:
	rm -rf $(EXECUTABLE) $(ARCHIVE)

.PHONY: uninstall
uninstall:
	rm "$(PREFIX)/$(EXECUTABLE)"


================================================
FILE: Package.swift
================================================
// swift-tools-version:5.2
import PackageDescription

let package = Package(
    name: "set-simulator-location",
    products: [
        .executable(
            name: "set-simulator-location",
            targets: [
                "set-simulator-location"
            ]
        )
    ],
    targets: [
        .target(
            name: "set-simulator-location",
            path: "sources"
        ),
    ]
)


================================================
FILE: README.md
================================================
# set-simulator-location

NOTE: As of Xcode 14 you can use `xcrun simctl location` to do most of
this instead, including setting specific routes. Use that if possible
(it does not currently support searching for locations).

This is a simple CLI for easily setting the location of the currently
running iOS Simulator.

## Usage

Set a specific latitude and longitude:

```sh
$ set-simulator-location -c 37.7765 -122.3918
```

Or using place search:

```sh
$ set-simulator-location -q Lyft HQ San Francisco
```

By default the location is set on all booted simulators. If you'd like
to change it for only one of the booted simulators you can pass `-s`
followed by the simulator's display name:

```sh
$ set-simulator-location -q Lyft HQ San Francisco -s iPhone X
```

NOTE: If you have multiple booted simulators with the same name, the
location will be set on all of them.

## Installation

With [`homebrew`](http://brew.sh/):

```sh
$ brew install lyft/formulae/set-simulator-location
```

With [`Mint`](https://github.com/yonaskolb/Mint):

```sh
$ mint install lyft/set-simulator-location
```

With a precompiled release:

1. Download the latest release from
   [here](https://github.com/lyft/set-simulator-location/releases/)
1. Install it some place in your `$PATH`

Manually:

```sh
$ make install
```

I have submitted [a Radar](http://www.openradar.me/30789939) to have
this behavior added to `simctl`.

### Development

To work on `set-simulator-location` you can make your changes and run
`make` to build from the command line. If you'd prefer to work in Xcode
you can run `make xcode` to generate a project using SwiftPM.


================================================
FILE: sources/cli.swift
================================================
import Foundation

func consumeArgument(name: String, from arguments: inout ArraySlice<String>) -> String? {
    guard let argumentIndex = arguments.firstIndex(of: name) else {
        return nil
    }

    let value = arguments.suffix(from: argumentIndex).dropFirst().joined(separator: " ")
    if value.isEmpty {
        exitWithUsage()
    }

    arguments = arguments.prefix(upTo: argumentIndex)
    return value
}

func createUUID(from string: String) throws -> UUID {
    if let uuid = UUID(uuidString: string) {
        return uuid
    }

    throw CommandLineError.invalidUUID(string: string)
}


================================================
FILE: sources/coordinate+extension.swift
================================================
import CoreLocation

extension CLLocationCoordinate2D {
    var isValid: Bool {
        return CLLocationCoordinate2DIsValid(self)
            && !(self.latitude == 0.0 && self.longitude == 0.0)
    }
}


================================================
FILE: sources/coordinate.swift
================================================
import CoreLocation

func coordinate(from arguments: [String]) -> Result<CLLocationCoordinate2D> {
    if arguments.count != 2 {
        return .failure("Incorrect number of arguments, expected 2 got \(arguments.count)")
    }

    guard let latitude = arguments.first.flatMap(Double.init),
            let longitude = arguments.last.flatMap(Double.init) else
    {
        return .failure("Expected 2 numbers, got '\(arguments[0])' and '\(arguments[1])'")
    }

    return .success(CLLocationCoordinate2D(latitude: latitude, longitude: longitude))
}


================================================
FILE: sources/errors.swift
================================================
import Foundation

enum CommandLineError: Error, CustomStringConvertible {
    case invalidUUID(string: String)

    var description: String {
        switch self {
        case .invalidUUID(let string):
            return "The UUID '\(string)' is invalid"
        }
    }
}

enum SimulatorFetchError: Error, CustomStringConvertible {
    case simctlFailed
    case failedToReadOutput
    case noBootedSimulators
    case noMatchingSimulators(name: String)
    case noMatchingUDID(udid: UUID)

    var description: String {
        switch self {
        case .simctlFailed:
            return "Running `simctl list` failed"
        case .failedToReadOutput:
            return "Failed to read output from simctl"
        case .noBootedSimulators:
            return "No simulators are currently booted"
        case .noMatchingSimulators(let name):
            return "No booted simulators named '\(name)'"
        case .noMatchingUDID(let udid):
            return "No booted simulators with udid: \(udid.uuidString)"
        }
    }
}


================================================
FILE: sources/main.swift
================================================
import Foundation

var arguments = CommandLine.arguments.dropFirst()
let deviceUUID = try consumeArgument(name: "-u", from: &arguments).map(createUUID)
let deviceName = consumeArgument(name: "-s", from: &arguments)

guard let flag = arguments.popFirst() else {
    exitWithUsage()
}

let commands = [
    "-c": coordinate,
    "-q": findLocation,
]

guard let command = commands[flag] else {
    exitWithUsage()
}

switch command(Array(arguments)) {
    case .success(let coordinate) where coordinate.isValid:
        do {
            let bootedSimulators = try getBootedSimulators()
            let simulators =
                try deviceUUID.map { try getSimulators(with: $0, from: bootedSimulators) }
                ?? deviceName.map { try getSimulators(named: $0, from: bootedSimulators) }
                ?? bootedSimulators
            postNotification(for: coordinate, to: simulators.map { $0.udid.uuidString })
            print("Setting location to \(coordinate.latitude) \(coordinate.longitude)")
        } catch let error as SimulatorFetchError {
            exitWithUsage(error: error.description)
        }
    case .success(let coordinate):
        exitWithUsage(error: "Coordinate: \(coordinate) is invalid")
    case .failure(let error):
        exitWithUsage(error: error)
}


================================================
FILE: sources/notification.swift
================================================
import CoreLocation
import Foundation

private let kNotificationName = "com.apple.iphonesimulator.simulateLocation"

func postNotification(for coordinate: CLLocationCoordinate2D, to simulators: [String]) {
    let userInfo: [AnyHashable: Any] = [
        "simulateLocationLatitude": coordinate.latitude,
        "simulateLocationLongitude": coordinate.longitude,
        "simulateLocationDevices": simulators,
    ]

    let notification = Notification(name: Notification.Name(rawValue: kNotificationName), object: nil,
                                    userInfo: userInfo)

    DistributedNotificationCenter.default().post(notification)
}


================================================
FILE: sources/query.swift
================================================
import CoreLocation
import Foundation
import MapKit

func findLocation(from arguments: [String]) -> Result<CLLocationCoordinate2D> {
    if arguments.isEmpty {
        return .failure("No arguments passed for location search")
    }

    let query = arguments.joined(separator: " ")
    let request = MKLocalSearch.Request()
    request.naturalLanguageQuery = query

    let search = MKLocalSearch(request: request)
    let (response, error) = search.perform()

    guard let placemark = response?.mapItems.first?.placemark else {
        return .failure("No locations found for '\(query)'")
    }

    guard let coordinate = placemark.location?.coordinate else {
        return .failure("No coordinate found for '\(placemark.name ?? "")'")
    }

    if let error = error {
        return .failure(error.localizedDescription)
    }

    return .success(coordinate)
}

private extension MKLocalSearch {
    func perform() -> (Response?, Error?) {
        var result: (Response?, Error?)?

        self.start { response, error in
            result = (response, error)
        }

        while result == nil {
            RunLoop.main.run(until: Date(timeIntervalSinceNow: 1))
        }

        return result!
    }
}


================================================
FILE: sources/result.swift
================================================
enum Result<T>{
    case success(T)
    case failure(String)
}

extension Result: CustomStringConvertible {
    var description: String {
        switch self {
            case .success(let value):
                return String(describing: value)
            case .failure(let error):
                return error
        }
    }
}


================================================
FILE: sources/simulators.swift
================================================
import Foundation


struct Simulators: Codable {
    private let devices: [String: [Simulator]]

    var bootedSimulators: [Simulator] {
        return self.devices.flatMap { $1 }.filter { $0.isBooted }
    }
}

struct Simulator: Codable {
    private let state: String
    fileprivate let name: String
    let udid: UUID

    var isBooted: Bool {
        return self.state == "Booted"
    }
}

func getSimulators(named name: String, from simulators: [Simulator]) throws -> [Simulator] {
    let matchingSimulators = simulators.filter { $0.name.lowercased() == name.lowercased() }
    if matchingSimulators.isEmpty {
        throw SimulatorFetchError.noMatchingSimulators(name: name)
    }

    return matchingSimulators
}

func getSimulators(with uuid: UUID, from simulators: [Simulator]) throws -> [Simulator] {
    let matchingSimulators = simulators.filter { $0.udid == uuid }
    if matchingSimulators.isEmpty {
        throw SimulatorFetchError.noMatchingUDID(udid: uuid)
    }

    return matchingSimulators
}

func getBootedSimulators() throws -> [Simulator] {
    let task = Process()
    task.launchPath = "/usr/bin/xcrun"
    task.arguments = ["simctl", "list", "-j", "devices"]

    let pipe = Pipe()
    task.standardOutput = pipe

    task.launch()

    let data = pipe.fileHandleForReading.readDataToEndOfFile()
    task.waitUntilExit()
    pipe.fileHandleForReading.closeFile()

    if task.terminationStatus != 0 {
        throw SimulatorFetchError.simctlFailed
    }

    do {
        return try JSONDecoder().decode(Simulators.self, from: data).bootedSimulators
    } catch {
        throw SimulatorFetchError.failedToReadOutput
    }
}


================================================
FILE: sources/stderr.swift
================================================
import Darwin

var stderrStream = STDErrOutputStream()

struct STDErrOutputStream: TextOutputStream {
    func write(_ string: String) {
        fputs(string, stderr)
    }
}

func exitWithUsage(error: String? = nil) -> Never {
    if let error = error {
        print(error, terminator: "\n\n", to: &stderrStream)
    }

    print("Usage: set-simulator-location [-c 0 0|-q San Francisco] [-s Simulator Name|-u Simulator udid]",
          to: &stderrStream)
    exit(EXIT_FAILURE)
}


================================================
FILE: xcodeproj.xcconfig
================================================
SUPPORTED_PLATFORMS = macosx