ios-box 0.2.1 → 0.2.3

data/README.md

@@ -1,23 +1,20 @@
 IosBox
 ======
 
-IosBox is collection of Rake Tasks that makes developing iOS apps more easy.
-It includes rake tasks that take care of updating app Info.plist with proper
-version information (e.g. build date, GIT hash, etc).
-Further version will integrate deployment options, such as deploy beta versions
-to TestFlight.
+IosBox is tool that integrates with XCode to automate some of the tasks.
 
 Current Features
 ----------------
 
 Currently IosBox supports following features:
 
-* <b>Build Prepare</b> (`iosbox:build:prepare`)
-  Build prepare task generates new build number and bundle version and stores
+* <b>Build Prepare</b> (`build prepare`)
+  Build prepare task generates new build and bundle version  and stores
   it to application Info.plist.
-  It also saves some needed path information to .buildCache for other tasks
+  It also prepares buildcache for further tasks.
 
-* <b>Version Mungle</b> (`iosbox:version:*`)
+* <b>Version Management</b> (`version`)
+  IosBox offers simple 
   IosBox offers simple tasks to bump version numbers. Either it is patch, minor or
   major version bump, IosBox automatically handles increasing current version number.
 
@@ -29,39 +26,48 @@ In the roadmap are following features (but not yet planned)
 * Asset management, slicing assets according to receipt etc.
 * More to come, open for suggestions...
 
-Installation
-------------
+# Installation
 
 Install `IosBox` gem if you haven't done yet so
 
 	$ gem install ios-box
 
-Create in the root of your project folder `Rakefile` -file with following contents:
-	
-	require 'ios-box'
-
-	IosBox::Tasks.new do |config|
-	  config.target = "iosboxdev"
-	end
-
 Integrate toolbox with your XCode project by executing following command:
 	
-	$ rake iosbox:integrate
+	$ ios-box integrate
 
 Notice! This command will modify your XCode project file and therefore can make your project to stop working.
 Make sure you have proper backups done.
 
-If you want to integrate IosBox manually, add following script as build phase, preferably as first phase.
+# Usage
+
+Run `ios-box help` in project folder to see available commands.
+
+# Commands
+
+## ios-box integrate
+
+Integrates ios-box to current project. During integration process you can
+choose which targets build preparation task is ran.
+
+## ios-box build prepare
+
+This task prepares build process and can be only ran during XCode build phase.
+
+## ios-box version show
+
+Displays current version information of the project.
+
+## ios-box version build
 
-	(cd $PROJECT_DIR; rake iosbox:build:prepare)
+Increments build number.
 
-Usage
------
+## ios-box version bump [major|minor]
 
-Run `rake -T` in project folder to see available commands.
+Bumps marketing version by one step. By default it increases patch level
+but if ptional argument is given, either major or minor version is increased.
 
-Copyright
----------
+# Copyright
 
 Copyright &copy; 2011 Mikko Kokkonen. See LICENSE.txt for
 further details.

data/bin/ios-box

@@ -4,4 +4,4 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'ios-box/cli'
 
-Ios::Box::CLI.start
+IOSBox::CLI.start

data/ios-box.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/ios-box/version', __FILE__)
+require File.expand_path('../lib/ios-box', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Mikko Kokkonen"]
@@ -13,9 +13,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "ios-box"
   gem.require_paths = ["lib"]
-  gem.version       = Ios::Box::VERSION
+  gem.version       = IOSBox::VERSION
   
   gem.add_runtime_dependency  "thor"
   gem.add_runtime_dependency  "grit"
   gem.add_runtime_dependency  "plist"
+  gem.add_runtime_dependency  "rubyzip"
+  gem.add_runtime_dependency  "rest-client"
+  gem.add_runtime_dependency  "nokogiri"
 end

data/lib/ios-box.rb

@@ -1,7 +1,3 @@
-require "ios-box/version"
-
-module Ios
-  module Box
-    # Your code goes here...
-  end
+module IOSBox
+  VERSION = "0.2.3"
 end

data/lib/ios-box/cli.rb

@@ -1,96 +1,99 @@
+require 'ios-box/config'
 require 'ios-box/tools'
 require 'ios-box/iosbox'
 require 'thor'
 require 'pbxproject'
 
-module Ios
-  module Box
-    class CLI < Thor
-      include Thor::Actions
-      
-      desc "version COMMAND", "Version related subcommands"
-      subcommand "version", Tools::Version
-      
-      desc "build COMMAND", "Build related subcommands"
-      subcommand "build", Tools::Build
-      
-      desc "integrate [PROJECT]", "Integrates ios-box with project, by default first founded"
-      def integrate(project = nil)
-        shell = Thor::Shell::Basic.new
-        
-        # Find our project
-        if project.nil?
-          project = Dir["*.xcodeproj"].first
-        end
-        
-        unless File.exists?(project) and File.directory?(project)
-          shell.error "Project #{project} is not valid."
-          exit
-        end
-        
-        shell.say "Integrating to project #{project}"
-        
-        # Find our project file, either from command-line or just using first one
-        xcode = project || Dir["*.xcodeproj"].first
-        raise "Cannot find project.pbxproj in #{xcode}" unless File.file? "#{xcode}/project.pbxproj"
-        
-        # Load our project file
-        pbx = PBXProject::PBXProject.new :file => "#{xcode}/project.pbxproj"
-        pbx.parse
-        
-        # If target missing, fetch first target
-        # Find all targets
-        targets = pbx.find_item :type => PBXProject::PBXTypes::PBXNativeTarget
-        if targets.nil? or targets.empty?
-          raise "XCode project does not have any targets!"
-        end
-        
-        # Generate build phase
-        # Try to find build phases
-        # prebuilds = pbx.find_item(:type => PBXProject::PBXTypes::PBXShellScriptBuildPhase) || []
-        # prebuilds.select! do |c|
-        #   !c.comment.match(/ios-box prepare/).nil?
-        # end
-        # 
-        prebuilds = [] # Always add new build phase
-        if prebuilds.empty?        
-          initPhase = PBXProject::PBXTypes::PBXShellScriptBuildPhase.new(
-            :shellPath => '/bin/sh',
-            :shellScript => "\"(cd $PROJECT_DIR; #{%x{which ios-box}.strip} build prepare)\"",
-            :showEnvVarsInLog => 0,
-            :name => '"ios-box prepare"'
-            )
-          initPhase.comment = "ios-box prepare"
-
-          pbx.add_item initPhase
-        else
-          initPhase = prebuilds.first
-        end
-        
-        _targets = ""
-        targets.each do |target|
-          if shell.yes?("Integrate with target #{target.name.value}? [yn]")
-            # Inject buildphase to target
-            # Add to target
-            target.add_build_phase initPhase, 0
-            _targets << "config.targets << \"#{target.name.value}\""
-          end
-        end
-        
-        # Create iosbox configuration file
-        create_file ".iosbox" do
-          "# ios-box configuration file\n" +
-          "# https://github.com/owl-forestry/ios-box\n" +
-          "#\n" +
-          "config.project = \"#{project}\"\n" +
-          "#{_targets}\n"
+module IOSBox
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "version COMMAND", "Version related subcommands"
+    subcommand "version", Tools::Version
+
+    desc "build COMMAND", "Build related subcommands"
+    subcommand "build", Tools::Build
+
+    desc "config COMMAND", "Configuration related subcommands"
+    subcommand "config", Tools::Config
+
+    desc "deploy COMMAND", "Deploymend subcommands"
+    subcommand "deploy", Tools::Deploy
+
+    desc "integrate [PROJECT]", "Integrates ios-box with project, by default first founded"
+    def integrate(project = nil)
+      shell = Thor::Shell::Basic.new
+
+      # Find our project
+      if project.nil?
+        project = Dir["*.xcodeproj"].first
+      end
+
+      unless File.exists?(project) and File.directory?(project)
+        shell.error "Project #{project} is not valid."
+        exit
+      end
+
+      shell.say "Integrating to project #{project}"
+
+      # Find our project file, either from command-line or just using first one
+      xcode = project || Dir["*.xcodeproj"].first
+      raise "Cannot find project.pbxproj in #{xcode}" unless File.file? "#{xcode}/project.pbxproj"
+
+      # Load our project file
+      pbx = PBXProject::PBXProject.new :file => "#{xcode}/project.pbxproj"
+      pbx.parse
+
+      # If target missing, fetch first target
+      # Find all targets
+      targets = pbx.find_item :type => PBXProject::PBXTypes::PBXNativeTarget
+      if targets.nil? or targets.empty?
+        raise "XCode project does not have any targets!"
+      end
+
+      # Generate build phase
+      # Try to find build phases
+      # prebuilds = pbx.find_item(:type => PBXProject::PBXTypes::PBXShellScriptBuildPhase) || []
+      # prebuilds.select! do |c|
+      #   !c.comment.match(/ios-box prepare/).nil?
+      # end
+      #
+      prebuilds = [] # Always add new build phase
+      if prebuilds.empty?
+        initPhase = PBXProject::PBXTypes::PBXShellScriptBuildPhase.new(
+          :shellPath => '/bin/sh',
+          :shellScript => "\"(cd $PROJECT_DIR; ios-box build prepare)\"",
+          :showEnvVarsInLog => 0,
+          :name => '"ios-box prepare"'
+        )
+        initPhase.comment = "ios-box prepare"
+
+        pbx.add_item initPhase
+      else
+        initPhase = prebuilds.first
+      end
+
+      targets.each do |target|
+        if shell.yes?("Integrate with target #{target.name.value}? [yn]")
+          # Inject buildphase to target
+          # Add to target
+          target.add_build_phase initPhase, 0
         end
-        # Append buildcache to gitignore
-        send((File.exists?(".gitignore") ? :append_to_file : :create_file), ".gitignore", ".buildcache\n")
-        
-        # Write project file
-        pbx.write_to :file => "#{xcode}/project.pbxproj"
       end
+
+      # Create iosbox configuration file
+      config = Config.new
+      config.project = project
+      config.targets = targets.collect{|c| c.name.value}
+      config.growl = true # Enable Growl support
+      config.deploy = {'autonotes' => true} # Generate deployment changelogs from GIT logs
+      config.save(".iosbox")
+
+      # Append buildcache to gitignore
+      send((File.exists?(".gitignore") ? :append_to_file : :create_file), ".gitignore", ".buildcache\n")
+
+      # Write project file
+      pbx.write_to :file => "#{xcode}/project.pbxproj"
     end
   end
 end

data/lib/ios-box/config.rb

@@ -1,23 +1,37 @@
-module Ios
-  module Box
-    class Config
-      attr_accessor :project
-      attr_reader :targets
+require 'yaml'
+require 'ostruct'
 
-      def self.load(file = ".iosbox")
+module IOSBox
+  class Config < OpenStruct
+    attr_accessor :file
+
+    def self.load(file)
+      if File.exists?(file)
+        config = self.new(YAML.load(File.read(file)))
+      else
         config = self.new
-        config.instance_eval(File.read(file), file)
-        config
-      end
-      
-      def initialize
-        @targets = []
-        @project = nil
       end
-      
-      def config
-        self
+
+      config.file = file
+      config
+    end
+
+    def save(file = nil)
+      puts "Saving config to #{file || @file}"
+      File.open(file || @file, 'w') {|io| io.puts @table.to_yaml }
+    end
+
+    def to_a
+      res = []
+      @table.collect do |k,v|
+        if v.kind_of?(Hash)
+          res << ["#{k.to_s}:", ""]
+          v.each {|k,v| res << ["  #{k.to_s}", v]}
+        else
+          res << [k.to_s, v]
+        end
       end
+      res
     end
   end
 end

data/lib/ios-box/deploy.rb

@@ -0,0 +1,96 @@
+require 'plist'
+require 'zip/zip'
+
+module IOSBox
+  module Deploy
+    autoload :Testflight, 'ios-box/deploy/testflight'
+    
+    class Deployer
+      attr_reader :iosbox
+      
+      def initialize(iosbox)
+        @iosbox = iosbox
+
+        if iosbox.config.growl
+          begin
+            require 'ruby_gntp'
+            
+            @growl = GNTP.new("ios-box")
+            @growl.register({:notifications => [
+                              {:name => "Deployment Succeeded", :enabled => true},
+                              {:name => "Deployment Failed", :enabled => true},
+            ]})
+          rescue LoadError
+            iosbox.config.growl = false
+            puts "Please install ruby_gntp gem if you want to enable Growl notifications."
+          end
+        end
+      end
+      
+      def notify(opts)
+        return unless iosbox.config.growl
+        
+        @growl.notify(
+          :name => opts[:name],
+          :title => opts[:title],
+          :text => opts[:text] || opts[:error]
+        )
+      end
+      
+      def create_ipa(path)
+        puts "Creating IPA from path #{path}..."
+        
+        # Check for missing plist
+        raise "Archive info.plist is missing" unless File.exists?(File.join(path, "Info.plist"))
+        pl = Plist::parse_xml(File.join(path, "Info.plist"))
+        raise "Invalid XCArchive version" unless pl['ArchiveVersion'] == 1
+
+        app_path = pl['ApplicationProperties']['ApplicationPath']
+        app_name = File.basename(app_path, File.extname(app_path))
+        ipa_name = File.join(path, "Products", "#{app_name}.ipa")
+        puts "Compressing #{app_path}"
+        if File.exists?(ipa_name)
+          File.unlink(ipa_name)
+        end
+        
+        Zip::ZipFile.open(ipa_name, Zip::ZipFile::CREATE) do |zip|
+          Dir["#{File.join(path, "Products", app_path)}/**/*"].each do |entry|
+            e_name = entry.gsub(/#{File.join(path, "Products", app_path)}\//, '')
+            e_name = "Payload/#{app_name}.app/#{e_name}"
+            zip.add e_name, entry
+          end
+        end
+        
+        ipa_name
+      end
+      
+      def create_dsym(path)
+        puts "Creating Zipped dSYM from path #{path}..."
+        
+        # Check for missing plist
+        raise "Archive info.plist is missing" unless File.exists?(File.join(path, "Info.plist"))
+        pl = Plist::parse_xml(File.join(path, "Info.plist"))
+        raise "Invalid XCArchive version" unless pl['ArchiveVersion'] == 1
+
+        app_path = pl['ApplicationProperties']['ApplicationPath']
+        app_name = File.basename(app_path)
+        dsym_name = File.join(path, "dSYMs", "#{app_name}.dSYM.zip")
+
+        if File.exists?(dsym_name)
+          File.unlink(dsym_name)
+        end
+        
+        Zip::ZipFile.open(dsym_name, Zip::ZipFile::CREATE) do |zip|
+          dsym_path = File.join(path, "dSYMs")
+          puts "Path #{dsym_path}"
+          Dir["#{File.join(dsym_path, "#{app_name}.dSYM")}/**/*"].each do |entry|
+            e_name = entry.gsub(/#{dsym_path}\//, '')
+            zip.add e_name, entry
+          end
+        end
+        
+        dsym_name        
+      end
+    end
+  end
+end