RubyMotion/lib/motion/project/target/extension_target.rb

# encoding: utf-8

# Copyright (c) 2012, HipByte SPRL and contributors
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

require 'motion/project/builder'

module Motion; module Project
  class ExtensionTarget
    include Rake::DSL if Object.const_defined?(:Rake) && Rake.const_defined?(:DSL)

    attr_accessor :type

    attr_reader :path

    def initialize(path, type, config, opts)
      @path = path
      @full_path = File.expand_path(path)
      @type = type
      @config = config
      @opts = opts
    end

    # This takes care of changing into the target's work directory, setting the
    # required environment variables, and passing on whether to be verbose.
    #
    # @param [String] task
    #        The rake task to invoke in the target's context.
    #
    # @return [Boolean] Whether or not invoking the rake task succeeded.
    #
    def rake(task)
      Dir.chdir(@full_path) do
        ENV["PWD"] = @full_path
        rake = "rake"
        if File.exist?("Gemfile") && ENV["BUNDLE_GEMFILE"]
          ENV["BUNDLE_GEMFILE"] = File.join(@full_path, "Gemfile")
          system(ENV, "bundle install") unless File.exist?("Gemfile.lock")
          rake = "bundle exec rake"
        end

        command = "#{environment_variables} #{rake} #{task}"
        if App::VERBOSE
          command << " --trace"
          puts command
        end
        system(ENV, command)
      end
    end

    def build(platform)
      @platform = platform

      task = if platform == 'iPhoneSimulator'
        "build:simulator"
      else
        if @config.distribution_mode
          "archive:distribution"
        else
          "build:device"
        end
      end

      unless rake(task)
        App.fail "Target '#{@path}' failed to build"
      end
    end

    def copy_products(platform)
      src_path = src_extension_path
      dest_path = destination_dir
      FileUtils.mkdir_p(File.join(@config.app_bundle(platform), 'PlugIns'))

      extension_path = destination_bundle_path

      if !File.exist?(extension_path) or File.mtime(src_path) > File.mtime(extension_path)
        App.info 'Copy', src_path
        FileUtils.cp_r(src_path, dest_path)

        # At build time Extensions do not know the bundle indentifier of its
        # parent app, so we have to modify their Info.plist later
        extension_dir = File.join(destination_dir, extension_name)
        info_plist = File.join(extension_dir, 'Info.plist')
        extension_bundle_name = `/usr/libexec/PlistBuddy -c "print CFBundleName" "#{info_plist}"`.strip
        extension_bundle_indentifer = `/usr/libexec/PlistBuddy -c "print CFBundleIdentifier" "#{info_plist}"`.strip
        if extension_bundle_indentifer.include?(".watchkitextension")
          extension_bundle_indentifer = "#{@config.identifier}.watchkitextension"
        else
          extension_bundle_indentifer = "#{@config.identifier}.#{extension_bundle_name}"
        end
        `/usr/libexec/PlistBuddy -c "set CFBundleIdentifier #{extension_bundle_indentifer}" "#{info_plist}"`
      end 
    end

    def codesign(platform)
      extension_dir = destination_bundle_path

      # Create bundle/ResourceRules.plist.
      resource_rules_plist = File.join(extension_dir, 'ResourceRules.plist')

      # Codesign executable
      codesign_cmd = "CODESIGN_ALLOCATE=\"#{File.join(@config.platform_dir(platform), 'Developer/usr/bin/codesign_allocate')}\" /usr/bin/codesign"
      if File.mtime(@config.project_file) > File.mtime(extension_dir) \
          or !system("#{codesign_cmd} --verify \"#{extension_dir}\" >& /dev/null")
        App.info 'Codesign', extension_dir
        entitlements = File.join(extension_dir, "Entitlements.plist")
        sh "#{codesign_cmd} -f -s \"#{@config.codesign_certificate}\" --resource-rules=\"#{resource_rules_plist}\" --entitlements #{entitlements} \"#{extension_dir}\""
      end
    end

    def clean
      rake 'clean'
    end

    def build_dir(config, platform)
      platform + '-' + config.deployment_target + '-' + config.build_mode_name
    end

    def src_extension_path
      @src_extension_path ||= begin
        path = File.join(@path, 'build', build_dir(@config, @platform), '*.appex')
        Dir[path].sort_by{ |f| File.mtime(f) }.last
      end
    end

    # @return [String] The directory inside the application bundle where the
    #                  extension should be located in the final product.
    #
    def destination_dir
      File.join(@config.app_bundle(@platform), 'PlugIns')
    end

    # @return [String, nil] The path to the extension bundle inside the
    #         application bundle or `nil` if it has not been built yet.
    #
    def destination_bundle_path
      File.join(destination_dir, extension_name)
    end

    # @return [String, nil] The name of the extension or `nil` if it has not
    #         been built yet.
    #
    def extension_name
      File.basename(src_extension_path)
    end

    def environment_variables
      [
        "RM_TARGET_SDK_VERSION='#{@config.sdk_version}'",
        "RM_TARGET_DEPLOYMENT_TARGET='#{@config.deployment_target}'",
        "RM_TARGET_XCODE_DIR='#{@config.xcode_dir}'",
        "RM_TARGET_HOST_APP_NAME='#{@config.name}'",
        "RM_TARGET_HOST_APP_IDENTIFIER='#{@config.identifier}'",
        "RM_TARGET_HOST_APP_PATH='#{File.expand_path(@config.project_dir)}'",
        "RM_TARGET_BUILD='1'",
        "RM_TARGET_ARCHS='#{@config.archs.inspect}'",
      ].join(' ')
    end

  end
end;end