ios_build_kit 0.0.1

data/Rakefile

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

data/bin/buildkit

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'ios_build_kit'
+
+args = ARGV.dup
+ARGV.clear
+
+config_file = args[0]
+
+system "clear"
+
+BuildKit::Utilities::Console.terminate_with_err "BuildKit requires a configuration file to run, see: (http://github.com/adamwaite/iOS-Build-Kit)." if config_file.nil?
+
+BuildKit.start_with_configuration config_file

data/ios_build_kit.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "ios_build_kit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ios_build_kit"
+  s.authors     = ["Adam Waite"]
+  s.email       = "adam@adamjwaite.co.uk"
+  s.homepage    = "https://github.com/adamwaite/iOS-Build-Kit"
+  s.version     = BuildKit::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "iOS Build Kit"
+  s.description = "iOS Build Tool CLI - Increment version • Decorate icon • Build app • Run unit tests • Create ipa artefact"
+
+  s.add_dependency "commander", "~> 4.1"
+  s.add_dependency "json", "~> 1.8"
+  s.add_dependency "paint", "~> 0.8"
+  s.add_dependency "nomad-cli", "~> 0.0.2"
+  s.add_dependency "rmagick", '~> 2.13'
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor|example|resources)/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+end

data/lib/ios_build_kit.rb

@@ -0,0 +1,12 @@
+module BuildKit
+
+  Dir["#{File.dirname(__FILE__)}/ios_build_kit/**/*.rb"].each { |f| load(f) }
+
+  def self.start_with_configuration config
+    BuildKit::Utilities::Assertions.assert_files_exist [config]
+    BuildKit::Utilities::Console.header_msg "BuildKit Run Started"
+    runner = BuildKit::Runner::TaskRunner.new({ config_file: config })
+  	runner.run_tasks!
+  end
+
+end

data/lib/ios_build_kit/task.rb

@@ -0,0 +1,24 @@
+module BuildKit
+  
+	module Tasks
+
+		class BuildKitTask
+
+			attr_reader :runner, :config, :task_options
+
+			def initialize(attributes = {})
+        prepare_task_with_runner_and_options! attributes[:runner], attributes[:opts]
+      end
+
+			def prepare_task_with_runner_and_options! runner, opts
+      	@runner = runner
+      	@config = runner.config
+      	@task_options = opts
+        assert_requirements
+      end
+
+		end
+
+	end
+ 
+end

data/lib/ios_build_kit/task_configuration.rb

@@ -0,0 +1,13 @@
+require 'ostruct'
+
+module BuildKit
+  
+	module Runner
+
+	  class TaskRunnerConfig < OpenStruct
+
+	  end
+
+ end
+  
+end

data/lib/ios_build_kit/task_runner.rb

@@ -0,0 +1,82 @@
+module BuildKit
+  
+  require 'yaml'
+
+  module Runner
+
+    class TaskRunner
+          
+      attr_reader :config, :preferences, :tasks, :outputs, :store
+      
+      def initialize(attributes = {})
+        passed = hash_from_yaml attributes[:config_file]
+        @config = TaskRunnerConfig.new(passed[:configuration]).freeze
+        @preferences = TaskRunnerConfig.new (passed[:preferences]).freeze
+        prepare_task_queue! passed[:tasks]
+        @store = {}
+        @outputs = {}
+      end
+
+      def run_tasks!
+        @tasks[:raw].each do |task_name, task_opts|
+          if task_opts[:run]
+            @tasks[:running] = task_name
+            BuildKit::Utilities::Console.header_msg "Running Task: #{task_name}"
+            BuildKit::Tasks.send task_name, self, task_opts[:options]
+          else
+            BuildKit::Utilities::Console.header_msg "Skipping Task: #{task_name}"
+          end
+        end
+        all_tasks_completed
+      end
+
+      def has_completed_task? task
+        @tasks[:completed].include? task
+      end
+
+      def task_completed! task, success_message, output
+        @tasks[:completed] << task
+        BuildKit::Utilities::Console.success_msg success_message
+        @outputs[task] = output
+      end
+
+      private
+
+      def hash_from_yaml file
+        YAML.load_file(file)
+      end
+
+      def prepare_task_queue! tasks
+        @tasks = { raw: {}, run: [], skip: [], completed: [], running: nil }
+        @tasks[:raw] = tasks.freeze
+        @tasks[:run] = tasks.select { |k, v| v[:run] == true }.map do |k, v| 
+          t = Hash.new
+          t[k] = { run: v[:run], options: v[:options] }
+          t
+        end.freeze
+        @tasks[:skip] = tasks.select { |k, v| v[:run] == false }.map do |k, v| 
+          t = Hash.new
+          t[k] = { run: v[:run], options: v[:options] }
+          t
+        end.freeze      
+        @tasks[:run].freeze
+        @tasks[:skip].freeze
+      end
+
+      def all_tasks_completed
+        unless @preferences.reports.nil?
+          if File.exists? @preferences.reports
+            build_report = BuildKit::Utilities::Reporter::create_report self
+            BuildKit::Utilities::Console.success_msg "BuildKit run report created at: #{build_report}"
+          else
+            puts "Warning: Report not created. Invalid directory specified: #{@preferences.reports}"
+          end
+        end
+        BuildKit::Utilities::Console.success_msg "\n😃  BuildKit Run Completed! Ran #{@tasks[:completed].count} tasks successfully!\n\n"
+      end
+
+    end
+
+  end
+      
+end

data/lib/ios_build_kit/tasks/create_ipa.rb

@@ -0,0 +1,94 @@
+module BuildKit
+  
+  module Tasks
+
+    def self.create_ipa runner, task_opts
+      task = CreateIPATask.new({ runner: runner, opts: task_opts })
+      task.run!
+    end
+      
+    private
+
+  class CreateIPATask < BuildKitTask
+
+      attr_accessor :artefact_filename
+
+      def initialize(attributes = {})
+        super
+        warn_about_missing_plist_config if @config.info_plist.nil?
+      end
+
+      def run!
+        build_artefact_filename!
+        run_command!
+        complete_task!
+      end
+
+      private
+
+      def assert_requirements
+        BuildKit::Utilities::Assertions.assert_tasks_completed [:xcode_build], @runner
+        BuildKit::Utilities::Assertions.assert_required_config [:code_sign, :provisioning_profile], @runner
+        BuildKit::Utilities::Assertions.assert_files_exist [@config.provisioning_profile]
+      end
+
+      def warn_about_missing_plist_config
+        BuildKit.warning_msg "Provide the :info_plist option in the config file to include the version number in the ipa file name" 
+      end
+
+      def build_artefact_filename!
+        name = @config.app_name.dup
+        if (!@config.info_plist.nil? and File.exists? @config.info_plist)
+          name << "-"
+          if @runner.has_completed_task? :increment_version
+            name << @runner.store[:new_version_number][:full]
+          else
+            name << BuildKit::Utilities::VersionNumber.plist_version_number[:full]
+          end
+        end
+        name << "-"
+        name << Time.now.to_i.to_s
+        name << ".ipa"
+        @artefact_filename = name
+      end
+
+      def artefact_full_path
+        build_artefact_filename! if @artefact_filename.nil?
+        @config.build_dir + @artefact_filename
+      end
+
+      def existing_ipa_count
+        Dir["#{@build_dir}*.ipa"].length
+      end
+
+      def build_command
+        workspace_arg = "-workspace \"#{@config.workspace}\""
+        sdk_arg = "-sdk #{@config.sdk}"
+        build_file_arg = "-v \"#{@config.build_dir}#{@config.app_name}.app\"" 
+        output_file_arg = "-o \"#{artefact_full_path}\"" 
+        code_sign_arg = "--sign #{@config.code_sign}"
+        provisioning_arg = "--embed \"#{@config.provisioning_profile}\""
+        "xcrun #{sdk_arg} PackageApplication #{build_file_arg} #{output_file_arg} #{provisioning_arg}"
+      end
+
+      def run_command!
+        command = build_command
+        @output = %x[#{command}]
+        puts @output if @task_options[:log]
+      end
+
+      def ipa_created_successfully?
+        File.exists? artefact_full_path
+      end
+
+      def complete_task!
+        runner.store[:artefact_created] = artefact_full_path if ipa_created_successfully?
+        message = (ipa_created_successfully?) ? "create_ipa completed, ipa at: #{artefact_full_path}" : "create_ipa task completed but the ipa was not created"
+        runner.task_completed! :create_ipa, message, @output 
+      end
+
+    end
+      
+  end
+  
+end

data/lib/ios_build_kit/tasks/decorate_icon.rb

@@ -0,0 +1,106 @@
+module BuildKit
+  
+  require 'rmagick'
+    
+  module Tasks
+
+    def self.decorate_icon runner, task_opts
+      task = DecorateIconTask.new({ runner: runner, opts: task_opts })
+      task.run!
+    end
+
+    private
+
+    class DecorateIconTask < BuildKitTask
+
+      attr_reader :decorated_icons
+
+      def initialize(attributes = {})
+        super
+        @decorated_icons = []
+      end
+
+      def run!
+        decorate_icons!
+        complete_task!
+      end
+
+      private
+
+      def assert_requirements
+        BuildKit::Utilities::Assertions.assert_required_config [:info_plist, :icon_dir], @runner
+        BuildKit::Utilities::Assertions.assert_files_exist [@config.info_plist, @config.icon_dir]
+      end
+
+      def version_number_to_draw
+        if @runner.has_completed_task? :increment_version
+          @runner.store[:new_version_number][:full]
+        else
+          BuildKit::Utilities::VersionNumber.plist_version_number(runner.config.info_plist)[:full]
+        end
+      end
+
+      def icon_files_to_decorate
+        to_decorate = []
+        Dir.glob("#{runner.config[:icon_dir]}*.png").each do |filename|
+          next if filename.include? "Decorated"
+          to_decorate << filename
+        end
+        to_decorate
+      end
+
+      def decorate_icons!
+        icon_files_to_decorate.each do |img_path|
+          @decorated_icons << create_decorated_version_of(img_path)
+        end
+      end
+
+      def create_decorated_version_of icon_path
+        original = Magick::ImageList.new icon_path
+        decorated_icon = original.copy
+
+        icon_dimension = original.rows
+
+        background = Magick::Draw.new
+        background.fill_opacity(0.75)
+        background.rectangle(0, icon_dimension - (icon_dimension * 0.225), icon_dimension, icon_dimension)
+        background.draw decorated_icon
+
+        annotation_params = { 
+          gravity: Magick::SouthGravity, 
+          pointsize: icon_dimension * 0.11 , 
+          stroke: 'transparent', 
+          fill: '#FFF', 
+          font_family: "Helvetica CY", 
+          font_weight: Magick::BoldWeight 
+        }
+
+        version_text = Magick::Draw.new
+        version_text.annotate(decorated_icon, 0, 0, 0, icon_dimension * 0.05  , "#{version_number_to_draw}") do
+          self.gravity = annotation_params[:gravity]
+          self.pointsize = annotation_params[:pointsize]
+          self.stroke = annotation_params[:stroke]
+          self.fill = annotation_params[:fill]
+          self.font_family = annotation_params[:font_family]
+          self.font_weight = annotation_params[:font_weight]
+        end
+
+        original_img_filename = File.basename icon_path
+        new_img_filename = "Decorated-" + original_img_filename
+        new_img_full_path = icon_path.gsub(original_img_filename, new_img_filename)
+
+        decorated_icon.write(new_img_full_path)
+
+        new_img_full_path
+      end
+
+      def complete_task!
+        message = "Icons have been decorated with #{version_number_to_draw}. They are here: " + @decorated_icons.join(",")
+        @runner.task_completed! :decorate_icons, message, message 
+      end
+
+    end
+
+  end
+        
+end

data/lib/ios_build_kit/tasks/increment_version.rb

@@ -0,0 +1,55 @@
+module BuildKit
+      
+  module Tasks
+
+    def self.increment_version runner, task_opts
+      task = IncrementVersionTask.new({ runner: runner, opts: task_opts })
+      task.run!
+    end
+
+    private
+
+    class IncrementVersionTask < BuildKitTask
+
+      attr_reader :existing_version_number, :new_version_number
+
+      def run!
+        read_existing_version!
+        calculate_new_version!
+        write_new_version!
+        complete_task!
+      end
+
+      private
+
+      def assert_requirements
+        BuildKit::Utilities::Assertions.assert_files_exist [@config.info_plist]
+      end
+
+      def read_existing_version!
+        @existing_version_number = BuildKit::Utilities::VersionNumber.plist_version_number @config.info_plist
+        @runner.store[:existing_version_number] = @existing_version_number
+      end
+
+      def calculate_new_version!
+        incremented_build_number = @existing_version_number[:build] + 1
+        @new_version_number = BuildKit::Utilities::VersionNumber.hash_from_version_and_build @existing_version_number[:major_minor_revision], incremented_build_number
+        @runner.store[:new_version_number] = @new_version_number
+      end
+
+      def write_new_version!
+        BuildKit::Utilities::PlistPal.write_value_in_plist(@config.info_plist, "CFBundleShortVersionString", @new_version_number[:major_minor_revision] )
+        BuildKit::Utilities::PlistPal.write_value_in_plist(@config.info_plist, "CFBundleVersion", @new_version_number[:build] )
+      end
+
+      def complete_task!
+        output = "incremented version number from #{@existing_version_number[:full]} to #{@new_version_number[:full]}"
+        message = output + " and written to plist successfully"
+        @runner.task_completed! :increment_version, message, output
+      end
+
+    end
+
+  end
+  
+end