ios_build_kit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f79d49883926329cab313795c0b2117054e131a
+  data.tar.gz: 715043655abfdac1e8d4a07b165cc56f2e7342f1
+SHA512:
+  metadata.gz: 09c60c8b413cf0538f9ac75933aaa3a9b1bac63de9375efe258d7204e01760bdf68674c9ffa909b854882c1da46d3c51cd981fc51e87599c7275911b2c735d3d
+  data.tar.gz: b291a043aa85897a81af74ec4fc64c7445e7a03baf6abc0ec715dfd747c0c1752092df848ac08e9900ebc1f8eed42c80bfa37c0a0db7b410feff5470fe1269ea

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    ios_build_kit (0.0.1)
+      commander (~> 4.1)
+      json (~> 1.8)
+      nomad-cli (~> 0.0.2)
+      paint (~> 0.8)
+      rmagick (~> 2.13)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aws-sdk (1.34.0)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+      uuidtools (~> 2.1)
+    certified (0.1.1)
+    commander (4.1.6)
+      highline (~> 1.6.11)
+    cupertino (0.9.5)
+      certified (>= 0.1.0)
+      commander (~> 4.1.2)
+      mechanize (~> 2.5.1)
+      nokogiri (~> 1.5.9)
+      security (~> 0.1.2)
+      shenzhen (>= 0.0.1)
+      term-ansicolor (~> 1.0.7)
+      terminal-table (~> 1.4.5)
+    diff-lcs (1.2.5)
+    domain_name (0.5.15)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (0.9.0)
+    dubai (0.0.5)
+      commander (~> 4.1)
+      json
+      rubyzip
+      sinatra (~> 1.3)
+      terminal-table (~> 1.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    highline (1.6.20)
+    houston (2.0.0)
+      commander (~> 4.1)
+      json
+    json (1.8.1)
+    mechanize (2.5.1)
+      domain_name (~> 0.5, >= 0.5.1)
+      mime-types (~> 1.17, >= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 2.5, >= 2.5.2)
+      nokogiri (~> 1.4)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (~> 0.0, >= 0.0.9)
+    mime-types (1.25.1)
+    multipart-post (1.2.0)
+    net-http-digest_auth (1.4)
+    net-http-persistent (2.9.4)
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.7.0)
+    nokogiri (1.5.11)
+    nomad-cli (0.0.2)
+      cupertino
+      dubai
+      houston
+      shenzhen
+      venice
+    ntlm-http (0.1.1)
+    paint (0.8.7)
+    rack (1.5.2)
+    rack-protection (1.5.2)
+      rack
+    rake (10.1.1)
+    rmagick (2.13.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubyzip (0.9.9)
+    security (0.1.2)
+    shenzhen (0.5.4)
+      aws-sdk (~> 1.0)
+      commander (~> 4.1)
+      dotenv (~> 0.7)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.9)
+      json (~> 1.8)
+      net-sftp (~> 2.1.2)
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    term-ansicolor (1.0.7)
+    terminal-table (1.4.5)
+    tilt (1.4.1)
+    unf (0.1.3)
+      unf_ext
+    unf_ext (0.0.6)
+    uuidtools (2.1.4)
+    venice (0.2.0)
+      commander (~> 4.1)
+      json
+      terminal-table (~> 1.4)
+    webrobots (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  ios_build_kit!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Adam Waite. All rights reserved.
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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/README.md

@@ -0,0 +1,269 @@
+iOS BuildKit
+===
+
+BuildKit is a modular command line interface for automating iOS project builds. BuildKit aims to relieve you from the pain of configuring continuous integration environments and build processes.
+
+Bundled build tasks include:
+
+- Increment the build number
+- Draw the build number on the app icon
+- Build the app
+- Run unit tests
+- Generate an .ipa artefact
+
+BuildKit is distributed as a Ruby gem with an executable that can be launched either in a continous integration server environment or on your development machine. The process is configured with a simple YAML file that describes the tasks to run and your project-specific options. This means that you can tailor the build process to meet your requirements.
+
+**Note**
+
+This repository was previosly known as Xcode-Project. It previously contained a project generator as well as a less developed build toolkit. The generator was removed due to the rapid advances in iOS technology. If you would like to continue using the previous version it's available [here](https://github.com/adamwaite/iOS-Build-Kit/releases).
+
+## Requirements
+
+- **Ruby 2.0+**: BuildKit is written and run with Ruby, you'll need a version higher than 2.0 because of the modern syntax. Check your Ruby version with `ruby -v`. [RVM](http://rvm.io/) makes it easy should you need to update.
+- **Xcode command line tools**: `xcode-select --install`
+- xctool: BuildKit uses [Facebook's xctool](https://github.com/facebook/xctool) to translate the standard Xcode CLI output from computer garbage to human readable form. Install with: `brew install xctool`
+- **ImageMagick**: Command line graphics library used to draw on the app icon. Install with: `brew install imagemagick`.
+- **GhostScript**: Command line text rendering library used to draw the version number on the app icon. Install with: `brew install ghostscript`.
+
+## Installation
+
+After the requirments have been met, BuildKit can be installed with:
+
+`gem install buildkit`
+
+## Usage
+
+BuildKit is launched from a command line environment with:
+
+```
+buildkit
+```
+
+Pass a configuration file to BuildKit with:
+
+```
+buildkit your-config-file.yml
+```
+
+### Configuration Files
+
+The configuration file describes three things:
+
+1. Task modules to run (and task-specific options)  
+2. Project configuration
+3. User preferences
+
+An example configuration file:
+
+```yaml
+:tasks:
+  :increment_version:
+    :run: true
+    :options:
+  :decorate_icon:
+    :run: true
+    :options:
+  :xcode_build:
+    :run: true
+    :options:
+   		:log: true
+  :run_tests:
+    :run: false
+    :options:
+    	:log: true
+  :create_ipa:
+    :run: true
+    :options:
+    	:log: true
+
+:configuration:
+  :app_name: "BuildKit"
+  :workspace: "/Users/adamwaite/iOS/Lib/BuildKit/iOS-Build-Kit/example/BuildKit.xcworkspace"
+  :info_plist: "/Users/adamwaite/iOS/Lib/BuildKit/iOS-Build-Kit/example/BuildKit/BuildKit-Info.plist"
+  :build_configuration: "Release"
+  :scheme: "BuildKit"
+  :sdk: "iphoneos"
+  :provisioning_profile: "/Users/adamwaite/iOS/Lib/BuildKit/iOS-Build-Kit/example/Provisioning/BuildKitTest.mobileprovision"
+  :code_sign: "iPhone Distribution: Alpaca Labs"
+  :icon_dir: "/Users/adamwaite/iOS/Lib/BuildKit/iOS-Build-Kit/example/BuildKit/Icon/"
+  :build_dir: "/Users/adamwaite/iOS/Lib/BuildKit/iOS-Build-Kit/example/Builds/"
+
+:preferences:
+  :reports: "/Users/adamwaite/iOS/Lib/BuildKit/Reports/"
+```
+
+#### Setting Tasks
+
+The `:tasks:` symbol is used to define what tasks you would like your process to run. If `:run:` is set to `true` on a particular task then that task will be executed as part of the build process. Setting `:run:` to `false` will mean that the task is skipped (note that some tasks depend on others, and may cause a graceful failure). In the examle above all tasks but for `run_tests` will be executed.
+
+The tasks will be run in the order that they appear in the list. It's recommended to follow the order shown in the example as they've been ordered to satisfy requirments and provide more value to the process. In the example the version is incremented with `increment_version`, followed by the newly incremented version being rendered on the app icon with `decorate_icon`, finally `xcode_build` and `create_ipa` are run and the version number appears on icon if the generated ipa is installed on a device. 
+
+Anything passed with the `:options:` symbol will be provided as an option. For example, taking the example configuration file above the `:log:` option on the `run_tests` task is set to `true` so the test output will be printed to the CLI.
+
+The Tasks section in this README describes all of the options available to each task.
+
+#### Setting Project Configuration
+
+To run the task modules successfully requires some project-specific configuration, this is done under the `:configuration:` symbol.
+
+- `:app_name:`: Your app's name!
+- `:workspace:`:  The path to your workspace (note that single Xcode project files aren't supported).
+- `:info_plist:`: The path to your workspace (note that single Xcode project files aren't supported).
+- `:build_configuration:`: Your build configuration (normally "Release" or suchlike)
+- `:scheme:`: Project scheme to build
+- `:sdk:`: SDK to build with (example: "iphoneos")
+- `:provisioning_profile:`: Path to a provisioning profile to sign the app with.
+- `:code_sign:`: The code signature, this is found in Xcode next to a selected provisioning profile (example: "iPhone Distribution: Alpaca Labs"). I recommend this incredible [Quick Look plug in](https://github.com/chockenberry/Provisioning) if you want to inspect profiles.
+- `:icon_dir:`: The path to a directory containing you icon image files. More on this in the Tasks `decorate_icon` section of this README.
+- `:build_dir:`: The path to drop any build and ipa files after they have been created.
+
+Note: if some required configuration has not been provided, or an invalid location has been provided for an option that requires a path, then BuildKit will gracefully fail.
+
+#### Setting User Preferences
+
+BuildKit can be configured to suit your own preference too. This is done under the `:preferences:` symbol. For example, to switch on build report generation set the `:reports:` symbol to `true`. User preferences are further described in the User Preferences section of this README.
+
+## Build Tasks
+
+BuildKit comes packaged with the following task modules:
+
+- `increment_version`: Increment the build number
+- `decorate_icon`: Overlay the build number on the application icon
+- `xcode_build`: Build the app
+- `run_tests`: Run unit tests
+- `create_ipa`: Generate an .ipa artefact
+
+### increment_version
+
+Increments the build version number in the Info-plist:
+
+![increment_version](resources/increment_version.png)
+
+Requires configuration:
+- `:info_plist:`
+
+### decorate_icon
+
+Duplicates you app icon files and aints the version number on top (incremented with `increment_version` or not).
+
+![decorate_icon](resources/decorate_icon.png)
+![decorate_icon](resources/decorate_icon2.png)
+
+*Decorate icon requires some convention to be followed*: Your app icon files should be contained in a dedicated directory of their own. To have the icon version number appear on top of a generated ipa requires you to drop the icon directory in to Xcode as a folder reference rather than a group. Then set the icon files in your Info-plist as:
+
+```
+<key>CFBundleIcons</key>
+	<dict>
+		<key>CFBundlePrimaryIcon</key>
+		<dict>
+			<key>CFBundleIconFiles</key>
+			<array>
+				<string>CONTAININGFOLDER/Decorated-ICONFILENAME</string>
+				<string>CONTAININGFOLDER/Decorated-ICONFILENAME</string>
+				<string>CONTAININGFOLDER/Decorated-ICONFILENAME</string>
+			</array>
+		</dict>
+	</dict>
+```
+
+If you're unsure check the example project in the repo.
+
+Requires configuration:
+- `:info_plist:`
+- `:icon_dir:`
+
+### xcode_build
+
+Builds the project:
+
+![xcode_build](resources/xcode_build.png)
+
+Requires configuration:
+- `:app_name:`
+- `:workspace:`
+- `:sdk:`
+- `:build_configuration:`
+- `:build_dir:`
+- `:scheme:`
+
+### run_tests
+
+Runs unit tests:
+
+![run_tests](resources/run_tests.png)
+
+*Note regarding Kiwi*: As of present you need to use 'edge Kiwi' due to [Kiwi issue 390](https://github.com/allending/Kiwi/issues/390). To used the latest Kiwi put `pod 'Kiwi/XCTest', git: 'https://github.com/allending/Kiwi'` in your Podfile.
+
+Requires configuration:
+- `:workspace:`
+- `:scheme:`
+
+### create_ipa
+
+Creates an .ipa build artefact.
+
+![create_ipa](resources/create_ipa.png)
+
+Requires previous tasks:
+- `xcode_build`
+
+Requires configuration:
+- `:workspace:`
+- `:scheme:`
+
+## User Preferences
+
+BuildKit includes features that can be enabled under the `:preferences:` symbol of a config file. This is a space to customise your build process.
+
+### User Preferences: Create Reports
+
+Set `:reports:` to a directory in your config file to create a JSON report containing the project configuration, build time, build outputs and test outputs after a BuildKit run has completed.
+
+Leaving the :reports:` preference blank will skip report generation.
+
+## Examples
+
+An example workspace has been included in the repo if you want to try it out. You'll need to change the paths in the `build_config.yml` configuration file first and run a `pod install`.
+
+## Roadmap
+
+Lots of plans for BuildKit:
+
+- Cover with RSpec specs (in progress)
+- Create a build task module to enable artefact distribution by wrapping [Shenzhen](https://github.com/nomad/shenzhen).
+- Add a means to allow custom task modules to be added to the process.
+- Add a task to email build reports.
+- Make `decorate_icon` compatible with Xcode 5 asset catalogues.
+- Add a generator for config files.
+- Add some colour to the output.
+- Beautify the reports.
+
+## Contributing
+
+All pull requests welcome! Please update the README with any new features.
+
+## Contact
+
+[@adamwaite](https://twitter.com/AdamWaite)
+
+## License
+
+Copyright (c) 2014 Adam Waite. All rights reserved.
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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/README.rdoc

@@ -0,0 +1,25 @@
+= ios_build_kit
+
+See https://github.com/adamwaite/iOS-Build-Kit
+
+Created by @adamwaite.
+
+Copyright (c) 2014 Adam Waite. All rights reserved.
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.