longbow-fdv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 417412bce1a52378508d826af49063e766f809c5
+  data.tar.gz: 379a1450dcfff594bc7c004f79b93afacfcf468b
+SHA512:
+  metadata.gz: 666b28e2b7c6b7bbf2f8a5f33e31758457e88cac998fba156573768f3347499669bcb301b4b715688e77e501177d9c8dbfa220c935ce2f5a0eada040d9c11f9c
+  data.tar.gz: 5cf73e6cd4de1b1fc11dabf24b41cfccba3e57279c670c1d12dd6433d0d90def13ed1e38919a315f675b54c9e191dcd72f70e334e43b2b9667aed25f3b2ec2cf

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in longbow.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Intermark Group
+
+MIT License
+
+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,151 @@
+![banner](resources/banner.png)
+
+**Problem**
+
+One codebase. Multiple App Store submission targets with different icons, launch images, info.plist keys, screenshots, etc.
+
+**Solution**
+
+```
+$ longbow install
+$ longbow shoot
+$ longbow aim
+```
+
+**About**
+
+Longbow is a command-line run ruby gem that duplicates the main target in your `.xcworkspace` or `.xcodeproj` file, then reads from a JSON file to fill out the rest of your new target. It looks for certain keys and does things like taking an icon image and resizing it for the various icons you'll need, and adding keys to the info.plist file for that target. The goal was to be practically autonomous in creating new targets and apps.
+
+Additionally, it can create screenshots for each target app store submission. You write a simple UIAutomation script (it's just JavaScript) and Longbow takes care of taking the screenshots for each combination of target, device, and language.
+
+**Requirements**
+
+Longbow requires Xcode 5+, and your app must use the new .xcassets paradigm for icons, launch screens, etc.
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Set Up](#set-up)
+* [Formatting longbow.json](#formatting-longbow-json)
+* [Create a Target](#create-a-target)
+* [Global Options](#global-options)
+* [The Future](#the-future)
+* [Contributing](#contributing)
+
+## Installation
+
+Longbow is officially hosted on [RubyGems](http://rubygems.org/gems/longbow), so installation is a breeze:
+
+    $ gem install longbow
+
+## Set Up
+
+Run `longbow install` in the directory where your `.xcworkspace` or `.xcodeproj` file lives. This will create a file, `longbow.json`, where they will be used to build out from here. You are almost ready to start creating new targets
+
+## Formatting longbow.json
+
+Here's a basic gist of how to format your `longbow.json` file:
+
+```json
+{
+	"targets":[
+		{
+			"name":"TargetName",
+			"icon_url":"https://somewhere.net/img.png",
+			"launch_phone_p_url":"https://somewhere.net/img2.png",
+			"info_plist": {
+        		"CFBundleIdentifier":"com.company.target1",
+            	"ProprietaryKey":"Value"
+      		}
+		},
+		{
+			"name":"TargetName2",
+			"icon_path":"/relative/path/to/file.png",
+			"launch_phone_p_path":"/relative/path/to/file2.png",
+			"info_plist": {
+        		"CFBundleIdentifier":"com.company.target2",
+            	"ProprietaryKey":"Value2"
+      		}
+		}
+	],
+ 	"global_info_keys":{
+ 		"somekey":"somevalue"
+ 	},
+    "devices":["iPhone","iPad"]
+}
+```
+
+In the top-level of the JSON file, we have 3 key/value pairs:
+
+* `targets`
+* `devices`
+* `global_info_keys`
+
+The `targets` section contains nested key/value pairs for each specific target. Devices holds an array of "iPhone" and/or "iPad". "global_info_keys" contains key/value pairs that you'd like to add to the info.plist file for all targets in this JSON file. Each target can contain the following keys:
+
+* `icon_url` or `icon_path`
+* `launch_phone_p_url` or `launch_phone_p_path`
+* `launch_phone_l_url` or `launch_phone_l_path`
+* `launch_tablet_p_url` or `launch_tablet_p_path`
+* `launch_tablet_l_url` or `launch_tablet_l_path`
+* `info_plist`
+* `name`
+
+The `icon_url` and `icon_path` key corresponds to the location of the icon image. It will be downloaded from the web if necessary, then resized depending on your device setting and added to the Images.xcassets file for that target. The same goes for the launch image keys. The p and l parts correspond to portrait and landscape orientation. The `info_plist` key corresponds to another set of key/value pairs that will be added or updated in the info.plist file specifically for this target.
+
+**Note:** `info_plist` takes precedence over `global_info_keys` for two of the same keys in both places.
+
+## Creating/Updating a Target
+
+Now that you're set up - it's time to add a target. Make sure that you have updated your `longbow.json` file with the correct information for your target, and then run the following command inside the project directory.
+
+`longbow shoot -n NameOfTarget`
+
+What this does is goes to your `longbow.json` file and looks for the correct target dictionary, and tries to create a new Target in your app. It then handles the various icons/info_plist additions specifically for this target. If your target already exists, it will just update the icon images and plist settings.
+
+If you leave off the `-n` option, it will run for all targets in the `longbow.json` file.
+
+**Other Options**
+
+* `-d, --directory` - if not in the current directory, specify a new path
+* `-u, --url` - the url of a longbow formatted JSON file
+* `-i, --images` - set this flag to not recreate images in the longbow file
+
+`longbow shoot -n NameOfTarget -d ~/Path/To/App -u http://someurl.com/longbow.json`
+
+## Global Options
+
+`--dontlog` will not log the status/operations to the console.
+
+`--help` will fill you in on what you need to do for an action.
+
+## Taking Screenshots
+
+So you've created all your targets and finished the first version of the app - now you need the screen shots to submit it to the App Store.
+
+First you'll need to write a single UIAutomation script to take the screenshots. You can see [Apple's Documentation](https://developer.apple.com/library/ios/documentation/DeveloperTools/Reference/UIAutomationRef/_index.html) for more information on writing the script. The part we're primarily concerned with is the captureLocalizedScreenshot() method provided by Longbow. This method will take the screenshot with a consistent naming scheme and place it in a folder for each target.
+
+`captureLocalizedScreenshot("homeScreen");` will create ~/Desktop/screenshots/TargetName/en-US/iOS-4-in\_\_\_portrait\_\_\_homeScreen.png
+
+Once you've created your automation script, you can run it by calling `longbow aim`. This command will generate a variation of your UIAutomation script for each target, then handle running it for each target. Grab a drink, depending on your script and your number of targets, this may take a while.
+
+**Options**
+
+Similar to the `shoot` command, there are flags you can use with this feature.
+
+* `-n` - name of the target to capture
+* `-d` - directory the project lives in
+* `-u` - url of the longbow.json file
+
+## The Future
+
+* Unit Tests
+* App Store deployment of Targets
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+gemspec = eval(File.read("longbow-fdv.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["longbow-fdv.gemspec"] do
+  system "gem build longbow-fdv.gemspec"
+end

data/bin/longbow

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'dotenv'
+Dotenv.load
+
+require 'commander/import'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'longbow'
+
+HighLine.track_eof = false # Fix for built-in Ruby
+
+program :version, Longbow::VERSION
+program :description, 'One codebase. Multiple App Store submission targets with different icons, launch images, info.plist keys, etc.'
+
+program :help, 'Author', 'Benjamin Gordon (@bennyguitar) for Intermark Group <interactive@intermarkgroup.com>'
+program :help, 'Website', 'https://github.com/intermark'
+program :help_formatter, :compact
+
+global_option('--dontlog') { $nolog = true }
+
+default_command :help
+
+require 'longbow/commands'

data/lib/longbow.rb

@@ -0,0 +1,6 @@
+# Library files
+require 'longbow/colors'
+require 'longbow/version'
+require 'longbow/commands'
+require 'longbow/images'
+require 'longbow/targets'

data/lib/longbow/colors.rb

@@ -0,0 +1,23 @@
+module Longbow
+  # Main Colorize Functions
+  def self.colorize(text, color_code)
+    puts "\e[#{color_code}m#{text}\e[0m"
+  end
+
+  # Specific Colors
+  def self.red(text)
+    colorize(text, 31)
+  end
+
+  def self.green(text)
+    colorize(text, 32)
+  end
+
+  def self.blue(text)
+    colorize(text, 36)
+  end
+
+  def self.purple(text)
+    colorize(text, 35)
+  end
+end

data/lib/longbow/commands.rb

@@ -0,0 +1,5 @@
+$:.push File.expand_path('../', __FILE__)
+
+require 'commands/shoot'
+require 'commands/install'
+require 'commands/aim'

data/lib/longbow/commands/aim.rb

@@ -0,0 +1,71 @@
+require 'fileutils'
+require 'longbow/colors'
+require 'longbow/targets'
+require 'longbow/images'
+require 'longbow/json'
+require 'json'
+
+command :aim do |c|
+  c.syntax = 'longbow aim'
+  c.syntax = 'Takes screenshots for each target in your workspace or project based on a UIAutomation script.'
+  c.description = ''
+  c.option '-s', '--script SCRIPT', 'Script used to get the app into the proper state for each screenshot'
+  c.option '-d', '--directory DIRECTORY', 'Path where the .xcodeproj or .xcworkspace file && the longbow.json file live.'
+  c.option '-u', '--url URL', 'URL of a longbow formatted JSON file.'
+  c.option '-n', '--name NAME', 'Name of the target to get a screenshot for.'
+  c.option '-v', '--verbose', 'Output all logs from UIAutomation/xcodebuild'
+
+  c.action do |args, options|
+    # Check for newer version
+    Longbow::check_for_newer_version unless $nolog
+
+    # Set Up
+    @script = options.script ? options.script : nil
+    @directory = options.directory ? options.directory : Dir.pwd
+    @url = options.url ? options.url : nil
+    @target_name = options.name
+    @targets = []
+
+    # Create JSON object
+    if @url
+      obj = Longbow::json_object_from_url @url
+    else
+      obj = Longbow::json_object_from_directory @directory
+    end
+
+    # Break if Bad
+    unless obj || Longbow::lint_json_object(obj)
+      Longbow::red "\n Invalid JSON. Please lint the file, and try again.\n"
+      next
+    end
+
+    # Check for Target Name
+    if @target_name
+      obj['targets'].each do |t|
+        @targets << t if t['name'] == @target_name
+      end
+
+      if @targets.length == 0
+        Longbow::red "\n  Couldn't find a target named #{@target_name} in the longbow.json file.\n"
+        next
+      end
+    else
+      @targets = obj['targets']
+    end
+
+    resources_path = File.dirname(__FILE__) + '/../../../resources'
+
+    FileUtils.cp "#{resources_path}/capture.js", "capture.js"
+    FileUtils.cp "#{resources_path}/config-screenshots.sh", "config-screenshots.sh"
+    FileUtils.cp "#{resources_path}/ui-screen-shooter.sh", "ui-screen-shooter.sh"
+    FileUtils.cp "#{resources_path}/unix_instruments.sh", "unix_instruments.sh"
+    @target_names = []
+    @targets.each do |t|
+      @target_names << t['name']
+    end
+    target_string = @target_names.join(',')
+    Longbow::blue "  Beginning screenshots..."
+    exec "#{resources_path}/aim.sh #{target_string} verbose" if options.verbose
+    exec "#{resources_path}/aim.sh #{target_string}" if !options.verbose
+  end
+end

data/lib/longbow/commands/install.rb

@@ -0,0 +1,54 @@
+$:.push File.expand_path('../../', __FILE__)
+require 'fileutils'
+require 'longbow'
+
+command :install do |c|
+  c.syntax = 'longbow install [options]'
+  c.summary = 'Creates the required files in your directory.'
+  c.description = ''
+  c.option '-d', '--directory DIRECTORY', 'Path where the .xcproj or .xcworkspace file && the longbow.json file live.'
+
+  c.action do |args, options|
+    # Check for newer version
+    Longbow::check_for_newer_version unless $nolog
+
+    # Set Up
+    @directory = options.directory ? options.directory : Dir.pwd
+    @json_path = @directory + '/longbow.json'
+
+    # Install
+    if File.exist?(@json_path)
+      Longbow::red '  longbow.json already exists at ' + @json_path
+    else
+      File.open(@json_path, 'w') do |f|
+        f.write('{
+	"targets":[
+		{
+			"name":"TargetName",
+			"icon_url":"https://somewhere.net/img.png",
+			"launch_phone_p_url":"https://somewhere.net/img2.png",
+			"info_plist": {
+        		"CFBundleIdentifier":"com.company.target1",
+            	"ProprietaryKey":"Value"
+      		}
+		},
+		{
+			"name":"TargetName2",
+			"icon_path":"/relative/path/to/file.png",
+			"launch_phone_p_path":"/relative/path/to/file2.png",
+			"info_plist": {
+        		"CFBundleIdentifier":"com.company.target2",
+            	"ProprietaryKey":"Value2"
+      		}
+		}
+	],
+ 	"global_info_keys":{
+ 		"somekey":"somevalue"
+ 	},
+    "devices":["iPhone","iPad"]
+}')
+      end
+      Longbow::green '  longbow.json created' unless $nolog
+    end
+  end
+end

data/lib/longbow/commands/shoot.rb

@@ -0,0 +1,70 @@
+$:.push File.expand_path('../../', __FILE__)
+require 'fileutils'
+require 'longbow/colors'
+require 'longbow/targets'
+require 'longbow/images'
+require 'longbow/json'
+require 'json'
+
+command :shoot do |c|
+  c.syntax = 'longbow shoot [options]'
+  c.summary = 'Creates/updates a target or all targets in your workspace or project.'
+  c.description = ''
+  c.option '-n', '--name NAME', 'Target name from the corresponding longbow.json file.'
+  c.option '-d', '--directory DIRECTORY', 'Path where the .xcodeproj or .xcworkspace file && the longbow.json file live.'
+  c.option '-u', '--url URL', 'URL of a longbow formatted JSON file.'
+  c.option '-i', '--images', 'Set this flag to not recreate images in the longbow file.'
+
+  c.action do |args, options|
+    # Check for newer version
+    Longbow::check_for_newer_version unless $nolog
+
+    # Set Up
+    @target_name = options.name ? options.name : nil
+    @directory = options.directory ? options.directory : Dir.pwd
+    
+    puts 'Directory'
+    puts @directory
+
+    @noimages = options.images ? true : false
+    @url = options.url ? options.url : nil
+    @targets = []
+
+    # Create JSON object
+    if @url
+      obj = Longbow::json_object_from_url @url
+    else
+      obj = Longbow::json_object_from_directory @directory
+    end
+
+    # Break if Bad
+    unless obj || Longbow::lint_json_object(obj)
+      Longbow::red "\n  Invalid JSON. Please lint the file, and try again.\n"
+      next
+    end
+
+
+    # Check for Target Name
+    if @target_name
+      obj['targets'].each do |t|
+        @targets << t if t['name'] == @target_name
+      end
+
+      if @targets.length == 0
+        Longbow::red "\n  Couldn't find a target named #{@target_name} in the longbow.json file.\n"
+        next
+      end
+    else
+      @targets = obj['targets']
+    end
+
+    # Begin
+    @targets.each do |t|
+      icon = t['icon_url'] || t['icon_path']
+      launch = t['launch_phone_p_url'] || t['launch_phone_p_path'] || t['launch_phone_l_url'] || t['launch_phone_l_path'] || t['launch_tablet_p_url'] || t['launch_tablet_p_path'] || t['launch_tablet_l_url'] || t['launch_tablet_l_path']
+      Longbow::update_target @directory, t['name'], obj['global_info_keys'], t['info_plist'], icon, launch
+      # Longbow::create_images(@directory, t, obj) unless @noimages
+      Longbow::green "  Finished: #{t['name']}\n" unless $nolog
+    end
+  end
+end