ocelotgraphql/ios

🎡👆 GraphQL at your fingertips

This is an iOS version of GraphQL playgrounds, similar to tools like GraphiQL or GraphQL Playground, with the benefit of a touch-optimized, truly native experience.

Contributing

Ocelot is currently in it's very early stages. As soon as we have a clearly defined roadmap we'll label issues contribution friendly. You can follow the ongoing development through our GitHub project board.

Do you have an interesting feature idea? Create an issue and start the discussion 💭.

Installation

[TBD]

ios's Issues

Create AppCoordinator

AppCoordinator will coordinate all other coordinators. It's part of the App module and uses a UINavigationController as its Presenter.

Handle Playground opening from without the app

When opening a Playground through Files or the "Recents" popover on iPad, the app is opened without actually opening the selected Playground.

Tasks

• Implement application(_:open:options:) in AppDelegate
• Tell AppCoordinator to open a Playground at the given URL

Create App module

According to the wiki page about App Architecture, we'll first have to create the App module. It will be based on the Single-View-Application template, but without the Main.storyboard.

Add simple Playground editor

In order to make this app useful, we need to add a Playground editor. This will be part of the EditorUI module.

Tasks

• Add PlaygroundViewController
• Add PlaygroundEditorViewController
• Add PlaygroundResultViewController
• Add play button
• Send request
• Show result in PlaygroundResultViewController

Playgrounds not showing up in recents

Currently, Playgrounds don’t show up in the recents tab of the PlaygroundBrowser.
Some googling lead to the assumption that this is caused by our com.ocelotgraphql.playground UTI does not conform to public.content.

Set up .ocelotplayground document type

As stated in the wiki, Playgrounds will be stored in .ocelotplayground package files. We'll start to implement this by exporting a UTI from the app module and using this UTI to create a new Ocelot Playground document type.

The exported UTI (com.ocelotgraphql.playground) will then be used to initialize the UIDocumentBrowserViewController in #11.

Set up TestFlight release lane

We'll use Fastlane to automatically release a new TestFlight-BETA.

Create Playground module

The Playground feature module will hold models and logic for Playground creation and editing. We'll start the implementation by creating a UIDocument subclass called Playground.

Automate certificate & provisioning profile management with Fastlane match

Currently, the App module uses automatic signing. Instead, we'll use Fastlane's match to automate this process and move back to manual signing.

Add Presenter & Coordinator

Presenter & Coordinator are two protocols that help us to interface between the app and feature modules. A Presenter is an abstraction for something like UINavigationController, whereas Coordinator helps to manage the flow of a specific scene.

Store GitHub personal access token in Keychain

Until we've built our account system we only support GitHub's GraphQL API. Because we don't want to ask the user for their personal access token each time they open the app, we'll ask once when the user is about to create their first playground and then store the token inside Keychain. This not only stores the token securely but automatically syncs the token via iCloud if the user has iCloud Keychain enabled.

• Implement key-value based Keychain abstraction
• Store GitHub access token in Keychain when creating a playground
• Retrieve GitHub access token from Keychain when opening a playground

Set up continuous integration

We'll use Travis CI for continuous integration. Furthermore, Fastlane & Danger will help us to streamline the build and release process.

• Run unit tests
• Comment on PRs
• Deploy a beta build to TestFlight

The CI will be executed by @ocebot, who has to have access to both this repo and our Fastlane Match-managed certificates repository.

Add PlaygroundBrowserUI module

The PlaygroundBrowserUI feature module will show a UIDocumentBrowserViewController for opening .ocelotplayground files.

Create GitHub playgrounds

As a first step, we should enable the user to create new GitHub GraphQL playgrounds. This will prompt the user to enter their GitHub API authorization token which we can then use as a header value when sending requests.

Add CommonUI module

The CommonUI module will include shared extensions for UIKit and components used by multiple feature modules.

Add NetworkSession

Instead of using URLSession directly we want to build an abstraction on top which allows us to mock the networking inside unit tests. The new NetworkSession protocol will be added to the Common module.

Tasks

• Create Common module
• Implement NetworkSession

Open Playgrounds

Currently, we can create new Playgrounds from the GitHub Playground Template, but we cannot edit them. The basic Playground editing functionality will be split across multiple issues (and branches), while this issue is specifically for opening a Playground and showing a barebone UI displaying the Playground's contents without any editing functionality.

Tasks

• Notify AppCoordinator when a Playground has been opened
• Create EditorUI module
• Create EditorCoordinator
• Create EditorViewController