xcbootstrap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f0099b2cd9dcbe94ece7657ec7063dca7c709fe
+  data.tar.gz: fefd5f54a1ec68b5a8511d4da859175cdfaf2a59
+SHA512:
+  metadata.gz: 900be5c2c06fce582e19be142ba3bfaef25d761af541668c4758749d4a3646985fc51c2c76c7c76f3a7280f328b43dfa34be4b9ea9fe16ff4f963dc52d71d247
+  data.tar.gz: 0e96d50fbb8c41530b3996ed219b47c1e3babf165ee30a955870713354cf677aa72d446a100062a9545c28971d02edfdd715773d99c2dc0a0481d0ec3d5e55c3

data/bin/xcbootstrap

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+
+require 'rubygems'
+require 'xcbootstrap'
+
+XCBootstrap::Cli.run

data/lib/xcbootstrap/bootstrap.rb

@@ -0,0 +1,65 @@
+require 'fileutils'
+require 'yaml'
+require 'xcbootstrap/template'
+
+module XCBootstrap
+  class Bootstrap
+    attr_accessor :template_dir
+    attr_accessor :project_dir
+    
+    def initialize template_root, template_name, project_dir
+      # FileUtils.mkdir_p project_dir
+      
+      @template_dir = File.join template_root, template_name
+      raise "Invalid template: could not find template directory #{@template_dir}" unless File.directory?(@template_dir)
+      
+      manifest_file = File.join @template_dir, "manifest.yml"
+      raise "Invalid template: could not find template manifest #{manifest_file}" unless File.exists?(manifest_file)
+      
+      @manifest = YAML.load_file manifest_file
+      raise "Invalid template: manifest file did not contain a hash of file mappings #{manifest_file}" unless manifest_data_is_valid(@manifest)
+      
+      @project_dir = File.expand_path(project_dir, Dir.getwd)
+    end
+    
+    def process
+      FileUtils.mkdir_p project_dir
+      
+      @manifest["files"].each do |file|
+        Template.new(file, @template_dir, @project_dir).process
+      end
+    end
+    
+    def finish
+      print_output_project_files
+      print_next_steps
+    end
+    
+    private
+    
+    def manifest_data_is_valid manifest_data
+      manifest_data.kind_of?(Hash) && !manifest_data["files"].nil? && manifest_data["files"].kind_of?(Array) && !manifest_data["files"].empty?
+    end
+    
+    def print_output_project_files
+      puts @project_dir
+      Dir.glob("#{@project_dir}/**/*").each do |item|
+        item.gsub(@project_dir, "").split("/").size.times do
+          print "."
+        end
+        puts File.basename(item)
+      end
+      puts "\n"
+    end
+    
+    def print_next_steps
+      cat_file(File.join(File.dirname(__FILE__), "next_steps.txt"))
+    end
+    
+    def cat_file file
+      File.readlines(file).each do |line|
+          puts line
+      end
+    end
+  end
+end

data/lib/xcbootstrap/cli.rb

@@ -0,0 +1,17 @@
+require 'clamp'
+require 'xcbootstrap/bootstrap'
+
+module XCBootstrap
+  class Cli < Clamp::Command
+
+    option ["-t", "--template"], "T", "name of the template to use", :required => true
+    option ["-p", "--project"], "P", "relative path to the desired project to create", :required => true
+
+    def execute
+      template_root = File.expand_path(File.join(File.dirname(__FILE__), "../../templates"))
+      bootstrapper = XCBootstrap::Bootstrap.new(template_root, template, project)
+      bootstrapper.process
+      bootstrapper.finish
+    end
+  end
+end

data/lib/xcbootstrap/next_steps.txt

@@ -0,0 +1,32 @@
+** Next steps **
+
+cd <path-to-project>
+
+rvm / rbenv: (if that's your thing)
+
+echo "ruby-2.0.0-p247" >> .ruby-version && echo "simple" >> .ruby-gemset && cd .
+
+** Configure git repo **
+
+git init
+git add .
+git commit -m "Initial project setup from template"
+
+** Install your dependencies **
+
+<install ruby/rvm/rbenv/bundler>
+bundle install
+pod install --no-integrate
+open simple.xcworkspace
+
+** Command line build **
+
+rake -T
+- will show you the tasks you can run
+
+You'll want to:
+- bootstrap any dependencies
+- build your app
+- run unit tests
+- configure frank
+- run your frank tests

data/lib/xcbootstrap/template.rb

@@ -0,0 +1,40 @@
+require 'fileutils'
+require 'ptools'
+
+module XCBootstrap
+  class Template
+    attr_accessor :from
+    attr_accessor :to
+    
+    def initialize file_info, template_dir, project_dir
+      @template_name = File.basename template_dir
+      @project_name = File.basename project_dir
+      
+      @from = File.join template_dir, file_info["from"]
+      relative_path_to = file_info["to"] || file_info["from"].gsub(@template_name, @project_name)
+      @to = File.join project_dir, relative_path_to
+    end
+    
+    def process 
+      FileUtils.mkdir_p File.dirname(to)
+      
+      if File.binary? from
+        FileUtils.cp from, to
+      else
+        sed_copy from, to
+      end
+    end
+    
+    private
+    
+    def sed_copy source, destination
+      File.open destination, "w" do |destination_file|
+        File.open source, "r" do |source_file|
+          source_file.each do |input_line|
+            destination_file.puts input_line.gsub(@template_name, @project_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xcbootstrap/version.rb

@@ -0,0 +1,3 @@
+module XCBootstrap
+  VERSION = "0.0.1"
+end

data/lib/xcbootstrap.rb

@@ -0,0 +1,3 @@
+require 'xcbootstrap/cli'
+require 'xcbootstrap/bootstrap'
+require 'xcbootstrap/template'

data/spec/acceptance/xcbootstrap_spec.rb

@@ -0,0 +1,57 @@
+describe 'xcbootstrap for a sample project' do
+  before(:all) do
+    @test_output_directory = File.join(File.dirname(__FILE__), '../../test_output')
+    @bootstrap_output = File.join(@test_output_directory, '/Output')
+    @xcbootstrap = File.expand_path(File.join(File.dirname(__FILE__), '../../bin/xcbootstrap'))
+  end
+  
+  context 'with full option names' do
+    before(:all) do
+      FileUtils.rm_rf @test_output_directory
+      @xcbootstrap_result = system("#{@xcbootstrap} --template Sample --project #{@bootstrap_output}")
+    end
+    
+    it 'should run successfully' do
+      @xcbootstrap_result.should be_true
+    end
+  
+    it 'should have created the output directory' do
+      File.exists?(@bootstrap_output).should be_true
+    end
+  
+    it 'should have created source and test directories' do
+      File.directory?(File.join(@bootstrap_output, "Output")).should be_true
+      File.directory?(File.join(@bootstrap_output, "OutputTests")).should be_true
+    end
+  
+    it 'should have created all the project files' do
+      output_files = Dir.glob("#{@bootstrap_output}/**/{.*,*}").select { |file| !File.directory?(file) }
+      output_files.size.should == 13
+    end
+  
+    it 'should have the git ignore file renamed' do
+      File.exists?(File.join(@bootstrap_output, ".gitignore")).should be_true
+    end
+  
+    it 'should have replaced the template with the project name' do
+      content = File.read(File.join(@bootstrap_output, "Output.xcodeproj/project.pbxproj"))
+      content.should_not include("Sample")
+      content.should include("Output")
+    end
+  end
+  
+  context 'with short option names' do
+    before(:all) do
+      FileUtils.rm_rf @test_output_directory
+      @xcbootstrap_result = system("#{@xcbootstrap} -t Sample -p #{@bootstrap_output}")
+    end
+    
+    it 'should run successfully' do
+      @xcbootstrap_result.should be_true
+    end
+  
+    it 'should have created the output directory' do
+      File.exists?(@bootstrap_output).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require_relative '../lib/xcbootstrap'
+
+def some_helper
+  true
+end

data/spec/unit/bootstrap_spec.rb

@@ -0,0 +1,100 @@
+require_relative '../spec_helper'
+require 'fakefs/spec_helpers'
+
+describe 'Bootstrap' do
+  include FakeFS::SpecHelpers
+  
+  context 'with a template that does not exist' do
+    it 'should raise an error' do
+      expect { XCBootstrap::Bootstrap.new("/tmp", "non_existant_template", "path-to-project") }.to raise_error
+    end
+  end
+  
+  context 'with a template with no manifest' do
+    it 'should raise an error' do
+      FileUtils.mkdir_p "/tmp/template_with_no_manifest"
+      expect { XCBootstrap::Bootstrap.new("/tmp", "template_with_no_manifest", "path-to-project") }.to raise_error
+    end
+  end
+  
+  context 'with an invalid manifest file' do
+    it 'should raise an error' do
+      create_invalid_manifest_with_content "fake manifest..\n... the end"
+      expect { XCBootstrap::Bootstrap.new("/tmp", "template_with_invalid_manifest", "path-to-project") }.to raise_error
+    end
+  end
+  
+  context 'with a manifest where files is not an array' do
+    it 'should raise an error' do
+      create_invalid_manifest_with_content "---\nfiles: blah"
+      expect { XCBootstrap::Bootstrap.new("/tmp", "template_with_invalid_manifest", "path-to-project") }.to raise_error
+    end
+  end
+  
+  context 'with a manifest where files is empty' do
+    it 'should raise an error' do
+      create_invalid_manifest_with_content "---\nfiles: []"
+      expect { XCBootstrap::Bootstrap.new("/tmp", "template_with_invalid_manifest", "path-to-project") }.to raise_error
+    end
+  end
+  
+  context 'with a valid template' do
+    before(:each) do
+      FileUtils.mkdir_p "/tmp/my_template"
+      File.open "/tmp/my_template/manifest.yml", "w" do |from_file|
+        from_file.puts "---"
+        from_file.puts "files:"
+        from_file.puts "  - from: some_file.txt"
+      end
+      
+      File.open "/tmp/my_template/some_file.txt", "w" do |from_file|
+        from_file.puts "some content"
+      end
+      
+      Dir.stub(:getwd).and_return("/tmp")
+    end
+    
+    context 'with a relative project path' do
+      let(:bootstrapper) { XCBootstrap::Bootstrap.new("/tmp", "my_template", "../tmp/path/to/my_project") }
+        
+      it 'should have the full path to the template' do
+        bootstrapper.template_dir.should == "/tmp/my_template"
+      end
+    
+      it 'should have the full path to the output project' do
+        bootstrapper.project_dir.should == "/tmp/path/to/my_project"
+      end
+    
+      context 'when the template is processed' do
+        before(:each) do
+          File.stub(:binary?).and_return(false)
+          bootstrapper.process
+        end
+      
+        it 'should create the output project directory' do
+          File.exists?(bootstrapper.project_dir).should be_true
+        end
+      
+        it 'should copy files to the output project' do
+          output_file = File.join bootstrapper.project_dir, "some_file.txt"
+          File.exists?(output_file).should be_true
+        end
+      end
+    end
+    
+    context 'with an absolute project path' do
+      let(:bootstrapper) { XCBootstrap::Bootstrap.new("/tmp", "my_template", "/tmp/path/to/my_project") }
+      
+      it 'should leave the project path absolute' do
+        bootstrapper.project_dir.should == "/tmp/path/to/my_project"
+      end
+    end
+  end
+  
+  def create_invalid_manifest_with_content content
+    FileUtils.mkdir_p "/tmp/template_with_invalid_manifest"
+    File.open "/tmp/template_with_invalid_manifest/manifest.yml", "w" do |from_file|
+      from_file.puts content
+    end
+  end
+end

data/spec/unit/cli_spec.rb

@@ -0,0 +1,33 @@
+require_relative '../spec_helper'
+
+describe 'Cli' do
+  before(:each) do
+    fake_boostrap = mock().as_null_object
+    XCBootstrap::Bootstrap.stub(:new).and_return(fake_boostrap)
+  end
+  
+  context 'with the template and project arguments' do
+    it 'should point to the default template dir' do
+      default_template_dir = File.expand_path("templates")
+      XCBootstrap::Bootstrap.should_receive(:new).with(default_template_dir, anything, anything)
+      XCBootstrap::Cli.new("", {}).run(["--template", "MyTemplate", "--project", "../MyProject"])
+    end
+    
+    it 'should bootstrap the project from the template' do
+      XCBootstrap::Bootstrap.should_receive(:new).with(anything, "MyTemplate", "../MyProject")
+      XCBootstrap::Cli.new("", {}).run(["--template", "MyTemplate", "--project", "../MyProject"])
+    end
+  end
+  
+  context 'without the template flag' do
+    it 'should raise an error' do
+      expect { XCBootstrap::Cli.new("", {}).run(["--project", "../MyProject"]) }.to raise_error
+    end
+  end
+  
+  context 'without the project flag' do
+    it 'should raise an error' do
+      expect { XCBootstrap::Cli.new("", {}).run(["--template", "MyTemplate"]) }.to raise_error
+    end
+  end
+end

data/spec/unit/template_spec.rb

@@ -0,0 +1,86 @@
+require_relative '../spec_helper'
+require 'fakefs/spec_helpers'
+
+describe 'Template' do
+  include FakeFS::SpecHelpers
+  
+  let(:template_dir) { "/tmp/template/sample" }
+  let(:project_dir) { "/tmp/output/new_project" }
+  
+  context 'with all fields specified' do
+    let(:template) { XCBootstrap::Template.new({"from" => "some/path/from","to" => "some/path/to"}, template_dir, project_dir) }
+    
+    it 'should have the from field inside the template dir' do
+      template.from.should == "/tmp/template/sample/some/path/from"
+    end
+    
+    it 'should have the to field inside the output project dir' do
+      template.to.should == "/tmp/output/new_project/some/path/to"
+    end
+  end
+  
+  context 'without the to field specified' do
+    let(:template) { XCBootstrap::Template.new({"from" => "some/path/from"}, template_dir, project_dir) }
+    
+    it 'should use the from field as the to' do
+      template.to.should == "/tmp/output/new_project/some/path/from"
+    end
+  end
+  
+  context 'with the template name in the from path' do
+    let(:template) { XCBootstrap::Template.new({"from" => "some/path/including/sample/in/path"}, template_dir, project_dir) }
+    
+    it 'should use the from field with the template name replaces with the project name' do
+      template.to.should == "/tmp/output/new_project/some/path/including/new_project/in/path"
+    end
+  end
+  
+  context 'when processing the file' do
+    let(:template) { XCBootstrap::Template.new({"from" => "path/to/file"}, template_dir, project_dir) }
+    
+    before(:each) do
+      File.stub(:binary?).and_return(false)
+      
+      FileUtils.mkdir_p "/tmp/template/sample/path/to/"
+      File.open "/tmp/template/sample/path/to/file", "w" do |from_file|
+        from_file.puts "content including sample name"
+      end
+    end
+    
+    it 'should create any intermediate directories to the destination' do
+      template.process
+      File.exists?("/tmp/output/new_project/path/to/").should be_true
+      File.directory?("/tmp/output/new_project/path/to/").should be_true
+    end
+    
+    it 'should copy the file to the destination' do
+      template.process
+      File.exists?("/tmp/output/new_project/path/to/file").should be_true
+      File.directory?("/tmp/output/new_project/path/to/file").should be_false
+    end
+    
+    it 'should replace occurances of the template name with the new project name' do
+      template.process
+      File.read("/tmp/output/new_project/path/to/file").should_not include("sample")
+      File.read("/tmp/output/new_project/path/to/file").should include("new_project")
+    end
+  end
+  
+  context 'when processing a binary file' do
+    let(:template) { XCBootstrap::Template.new({"from" => "path/to/binary/file"}, template_dir, project_dir) }
+    
+    before(:each) do
+      File.stub(:binary?).and_return(true)
+      
+      FileUtils.mkdir_p "/tmp/template/sample/path/to/binary"
+      File.open "/tmp/template/sample/path/to/binary/file", "wb" do |from_file|
+        from_file.puts "content including sample name"
+      end
+    end
+    
+    it 'should not replace occurances of the template name' do
+      template.process
+      File.read("/tmp/output/new_project/path/to/binary/file").should include("sample")
+    end
+  end
+end

data/templates/Sample/Sample/AppDelegate.h

@@ -0,0 +1,15 @@
+//
+//  AppDelegate.h
+//  Sample
+//
+//  Created by Stewart Gleadow on 12/06/13.
+//  Copyright (c) 2013 yourcompanyname. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+
+@interface AppDelegate : UIResponder <UIApplicationDelegate>
+
+@property (strong, nonatomic) UIWindow *window;
+
+@end

data/templates/Sample/Sample/AppDelegate.m

@@ -0,0 +1,49 @@
+//
+//  AppDelegate.m
+//  Sample
+//
+//  Created by Stewart Gleadow on 12/06/13.
+//  Copyright (c) 2013 yourcompanyname. All rights reserved.
+//
+
+#import "AppDelegate.h"
+
+@implementation AppDelegate
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+    self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
+    // Override point for customization after application launch.
+    self.window.backgroundColor = [UIColor whiteColor];
+    [self.window makeKeyAndVisible];
+    return YES;
+}
+
+- (void)applicationWillResignActive:(UIApplication *)application
+{
+    // Sent when the application is about to move from active to inactive state. This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits the application and it begins the transition to the background state.
+    // Use this method to pause ongoing tasks, disable timers, and throttle down OpenGL ES frame rates. Games should use this method to pause the game.
+}
+
+- (void)applicationDidEnterBackground:(UIApplication *)application
+{
+    // Use this method to release shared resources, save user data, invalidate timers, and store enough application state information to restore your application to its current state in case it is terminated later. 
+    // If your application supports background execution, this method is called instead of applicationWillTerminate: when the user quits.
+}
+
+- (void)applicationWillEnterForeground:(UIApplication *)application
+{
+    // Called as part of the transition from the background to the inactive state; here you can undo many of the changes made on entering the background.
+}
+
+- (void)applicationDidBecomeActive:(UIApplication *)application
+{
+    // Restart any tasks that were paused (or not yet started) while the application was inactive. If the application was previously in the background, optionally refresh the user interface.
+}
+
+- (void)applicationWillTerminate:(UIApplication *)application
+{
+    // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
+}
+
+@end

data/templates/Sample/Sample/Sample-Info.plist

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleDisplayName</key>
+	<string>${PRODUCT_NAME}</string>
+	<key>CFBundleExecutable</key>
+	<string>${EXECUTABLE_NAME}</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.yourcompanyname.${PRODUCT_NAME:rfc1034identifier}</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>${PRODUCT_NAME}</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>LSRequiresIPhoneOS</key>
+	<true/>
+	<key>UIRequiredDeviceCapabilities</key>
+	<array>
+		<string>armv7</string>
+	</array>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>UISupportedInterfaceOrientations~ipad</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationPortraitUpsideDown</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+</dict>
+</plist>

data/templates/Sample/Sample/Sample-Prefix.pch

@@ -0,0 +1,14 @@
+//
+// Prefix header for all source files of the 'Sample' target in the 'Sample' project
+//
+
+#import <Availability.h>
+
+#ifndef __IPHONE_3_0
+#warning "This project uses features only available in iOS SDK 3.0 and later."
+#endif
+
+#ifdef __OBJC__
+    #import <UIKit/UIKit.h>
+    #import <Foundation/Foundation.h>
+#endif

data/templates/Sample/Sample/main.m

@@ -0,0 +1,18 @@
+//
+//  main.m
+//  Sample
+//
+//  Created by Stewart Gleadow on 12/06/13.
+//  Copyright (c) 2013 yourcompanyname. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+
+#import "AppDelegate.h"
+
+int main(int argc, char *argv[])
+{
+    @autoreleasepool {
+        return UIApplicationMain(argc, argv, nil, NSStringFromClass([AppDelegate class]));
+    }
+}