hotcocoa 0.5.1 → 0.6.0pre

data/lib/hotcocoa/application_builder.rb

@@ -1,294 +1,390 @@
 framework 'Foundation'
 
 require 'fileutils'
+require 'rbconfig'
+require 'yaml'
 
 module HotCocoa
-  
+
   class ApplicationBuilder
-    
+
+    ##
+    # @todo support CFBundleDocumentTypes
+    # @todo support CFBundleShortVersionString
+    # @todo support NSHumanReadableCopyright
+    # @todo support arbitrary info.plist key/value pairs
     class Configuration
-      
-      attr_reader :name, :version, :icon, :resources, :sources, :info_string, :load
-      
-      def initialize(file)
-        require 'yaml'
-        yml = YAML.load(File.read(file))
-        @name = yml["name"]
-        @load = yml["load"]
-        @version = yml["version"] || "1.0"
-        @icon = yml["icon"]
-        @info_string = yml["info_string"]
-        @sources = yml["sources"] || []
-        @resources = yml["resources"] || []
-        @overwrite = yml["overwrite"] == true ? true : false
-      end
-      
-      def overwrite?
-        @overwrite
-      end
 
-      def icon_exist?
-        @icon ? File.exist?(@icon) : false
-      end
+      ##
+      # Name of the app
+      #
+      # @return [String]
+      attr_reader :name
 
-    end
-    
-    ApplicationBundlePackage = "APPL????"
-    
-    attr_accessor :name, :load_file, :sources, :overwrite, :icon, :version, :info_string, :resources, :deploy
-    
-    def self.build(config, options={:deploy => false})
-      if !config.kind_of?(Configuration) || !$LOADED_FEATURES.detect {|f| f.include?("standard_rake_tasks")}
-        require 'rbconfig'
-        puts "Your Rakefile needs to be updated.  Please copy the Rakefile from:"
-        puts File.expand_path(File.join(Config::CONFIG['datadir'], "hotcocoa_template", "Rakefile"))
-        exit
-      end
-      builder = new
-      builder.deploy = options[:deploy] == true ? true : false
-      builder.name = config.name
-      builder.load_file = config.load
-      builder.icon = config.icon if config.icon_exist?
-      builder.version = config.version
-      builder.info_string = config.info_string
-      builder.overwrite = config.overwrite?
-      config.sources.each do |source|
-        builder.add_source_path source
+      ##
+      # Reverse URL unique identifier
+      #
+      # @example Identifier for Mail.app
+      #
+      #  'com.apple.mail'
+      #
+      # @return [String]
+      attr_reader :identifier
+
+      ##
+      # Version of the app
+      #
+      # @return [String]
+      attr_reader :version
+
+      ##
+      # Path to the icon file
+      #
+      # @return [String]
+      attr_reader :icon
+
+      ##
+      # Globbing patterns describing where to find resources that need
+      # to be copied into the app bundle
+      #
+      # @return [Array<String>]
+      attr_reader :resources
+
+      ##
+      # Globbing patterns describing where to find source code that
+      # needs to be copied into the app bundle
+      #
+      # @return [Array<String>]
+      attr_reader :sources
+
+      ##
+      # Whether the app is an daemon with UI or a regular app
+      #
+      # @return [Boolean]
+      attr_reader :agent
+
+      ##
+      # Whether to include the Ruby stdlib in the app
+      #
+      # @return [Boolean]
+      attr_reader :stdlib
+
+      ##
+      # Any `.xcdatamodel` directories to compile and add to the app
+      # bundle
+      #
+      # @return [Array<String>]
+      attr_reader :data_models
+
+      ##
+      # Four letter code identifying bundle type, the default value is 'APPL'
+      # to specify the bundle is an application
+      #
+      # @return [String]
+      attr_reader :type
+
+      ##
+      # Four letter code that is a signature of the bundle, defaults
+      # to '????' since most apps never set this value
+      #
+      # @example TextEdit
+      #
+      #  'ttxt'
+      #
+      # @example Mail
+      #
+      #  'emal'
+      #
+      # @return [String]
+      attr_reader :signature
+
+      ##
+      # An array of gem names to embed in the app bundle during
+      # deployment
+      #
+      # @return [Array<String>]
+      attr_reader :gems
+
+      ##
+      # Whether or not to embed BridgeSupport files embedding the
+      # MacRuby framework
+      #
+      # @return [Boolean]
+      attr_reader :embed_bs
+      alias_method :embed_bs?, :embed_bs
+
+      ##
+      # Always make a clean build of the app
+      #
+      # @return [Boolean]
+      attr_reader :overwrite
+      alias_method :overwrite?, :overwrite
+
+      # @todo validation (sources should not be an empty array)
+      def initialize file
+        yml          = YAML.load(File.read(file))
+        @name        = yml['name'] # mandatory
+        @icon        = yml['icon']
+        @identifier  = yml['identifier']  || "com.#{@name}"
+        @version     = yml['version']     || '1.0'
+        @sources     = yml['sources']     || [] # this should be mandatory?
+        @resources   = yml['resources']   || []
+        @data_models = yml['data_models'] || []
+        @gems        = yml['gems']        || []
+        @type        = yml['type']        || 'APPL'
+        @signature   = yml['signature']   || '????'
+        @overwrite   = yml['overwrite'] == true  ? true  : false
+        @agent       = yml['agent']     == true  ? '1'   : '0'
+        @stdlib      = yml['stdlib']    == false ? false : true
+        @embed_bs    = yml['embed_bs']  == false ? false : true
       end
-      config.resources.each do |resource|
-        builder.add_resource_path resource
+
+      def icon_exists?
+        @icon ? File.exist?(@icon) : false
       end
-      builder.build
     end
 
-    # Used by the "Embed MacRuby" Xcode target.
-    def self.deploy(path)
-      raise "Given path `#{path}' does not exist" unless File.exist?(path)
-      raise "Given path `#{path}' does not look like an application bundle" unless File.extname(path) == '.app'
-      deployer = new
-      Dir.chdir(File.dirname(path)) do
-        deployer.name = File.basename(path, '.app') 
-        deployer.deploy
+    ##
+    # The cached app configuration options
+    #
+    # @return [HotCocoa::ApplicationBuilder::Configuration]
+    attr_accessor :config
+
+    ##
+    # Whether or not to build the app bundle for deployment by calling
+    # `macruby_deploy` on the generated app bundle
+    #
+    # @return [Boolean]
+    attr_accessor :deploy
+    alias_method  :deploy?, :deploy
+
+    # @return [Array<String>]
+    attr_accessor :sources
+
+    # @return [Array<String>]
+    attr_accessor :resources
+
+    # @return [Array<String>]
+    attr_accessor :data_models
+
+    def self.build config, opts = {}
+      options = { deploy: false }.merge opts
+
+      builder        = new
+      builder.config = config
+      builder.deploy = options[:deploy]
+
+      config.sources.each   { |source| builder.add_source_path(source) }
+      config.resources.each { |resource| builder.add_resource_path(resource) }
+      config.data_models.each do |data|
+        builder.add_data_model(data) if File.extname(data) == '.xcdatamodel'
       end
+
+      builder.build
     end
 
     def initialize
-      @sources = []
-      @resources = []
+      @sources     = []
+      @resources   = []
+      @data_models = []
     end
-      
+
     def build
       check_for_bundle_root
       build_bundle_structure
       write_bundle_files
       copy_sources
       copy_resources
-      deploy if deploy?
-      copy_icon_file if icon
-    end
-   
-    def deploy 
-      copy_framework
+      compile_data_models
+      embed_framework if deploy?
+      copy_icon_file if config.icon_exists?
     end
 
-    def deploy?
-      @deploy
-    end
-    
-    def overwrite?
-      @overwrite
-    end
-    
-    def add_source_path(source_file_pattern)
+    def add_source_path source_file_pattern
       Dir.glob(source_file_pattern).each do |source_file|
         sources << source_file
       end
     end
 
-    def add_resource_path(resource_file_pattern)
+    def add_resource_path resource_file_pattern
       Dir.glob(resource_file_pattern).each do |resource_file|
         resources << resource_file
       end
     end
-    
-    private
-    
-      def check_for_bundle_root
-        if File.exist?(bundle_root) && overwrite?
-          `rm -rf #{bundle_root}`
-        end
-      end
-    
-      def build_bundle_structure
-        Dir.mkdir(bundle_root) unless File.exist?(bundle_root)
-        Dir.mkdir(contents_root) unless File.exist?(contents_root)
-        Dir.mkdir(frameworks_root) unless File.exist?(frameworks_root)
-        Dir.mkdir(macos_root) unless File.exist?(macos_root)
-        Dir.mkdir(resources_root) unless File.exist?(resources_root)
-      end
-      
-      def write_bundle_files
-        write_pkg_info_file
-        write_info_plist_file
-        build_executable unless File.exist?(File.join(macos_root, objective_c_executable_file))
-        write_ruby_main
+
+    def add_data_model model
+      Dir.glob(model).each do |data|
+        data_models << data
       end
-      
-      def copy_framework
-        unless File.exist?(File.join(frameworks_root, 'MacRuby.framework'))
-          FileUtils.mkdir_p frameworks_root 
-          FileUtils.cp_r macruby_framework_path, frameworks_root
-        end
-        `install_name_tool -change #{current_macruby_path}/usr/lib/libmacruby.dylib @executable_path/../Frameworks/MacRuby.framework/Versions/#{current_macruby_version}/usr/lib/libmacruby.dylib '#{macos_root}/#{objective_c_executable_file}'`
+    end
+
+
+    private
+
+    def check_for_bundle_root
+      FileUtils.rm_rf bundle_root if File.exist?(bundle_root) && config.overwrite?
+    end
+
+    def build_bundle_structure
+      [bundle_root, contents_root, frameworks_root,
+       macos_root, resources_root].each do |dir|
+        Dir.mkdir(dir) unless File.exist?(dir)
       end
-      
-      def copy_sources
-        FileUtils.cp_r load_file, resources_root unless sources.include?(load_file)
-        sources.each do |source|
-          destination = File.join(resources_root, source)
-          FileUtils.mkdir_p(File.dirname(destination)) unless File.exist?(File.dirname(destination))
-          FileUtils.cp_r source, destination
-        end
+    end
+
+    def write_bundle_files
+      write_pkg_info_file
+      write_info_plist_file
+      build_executable unless File.exist?(File.join(macos_root, objective_c_executable_file))
+      write_ruby_main
+    end
+
+    def copy_sources
+      sources.each do |source|
+        destination = File.join(resources_root, source)
+        FileUtils.mkdir_p(File.dirname(destination)) unless File.exist?(File.dirname(destination))
+        FileUtils.cp_r source, destination
       end
-      
-      def copy_resources
-        resources.each do |resource|
-          destination = File.join(resources_root, resource.split("/")[1..-1].join("/"))
-          FileUtils.mkdir_p(File.dirname(destination)) unless File.exist?(File.dirname(destination))
+    end
+
+    def copy_resources
+      resources.each do |resource|
+        destination = File.join(resources_root, resource.split("/")[1..-1].join("/"))
+        FileUtils.mkdir_p(File.dirname(destination)) unless File.exist?(File.dirname(destination))
+
+        if resource =~ /\.xib$/
+          destination.gsub!(/.xib/, '.nib')
+          puts `ibtool --compile #{destination} #{resource}`
+        else
           FileUtils.cp_r resource, destination
         end
       end
-      
-      def copy_icon_file
-        FileUtils.cp(icon, icon_file) unless File.exist?(icon_file)
-      end
-      
-      def write_pkg_info_file
-        File.open(pkg_info_file, "wb") {|f| f.write ApplicationBundlePackage}
-      end
+    end
 
-      def write_info_plist_file
-        File.open(info_plist_file, "w") do |f|
-          f.puts %{<?xml version="1.0" encoding="UTF-8"?>}
-          f.puts %{<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">}
-          f.puts %{<plist version="1.0">}
-          f.puts %{<dict>}
-          f.puts %{	<key>CFBundleDevelopmentRegion</key>}
-          f.puts %{ <string>English</string>}
-          f.puts %{ <key>CFBundleIconFile</key>} if icon
-          f.puts %{ <string>#{name}.icns</string>} if icon
-          f.puts %{ <key>CFBundleGetInfoString</key>} if info_string
-          f.puts %{ <string>#{info_string}</string>} if info_string
-          f.puts %{	<key>CFBundleExecutable</key>}
-          f.puts %{	<string>#{name.gsub(/ /, '')}</string>}
-          f.puts %{	<key>CFBundleIdentifier</key>}
-          f.puts %{	<string>com.yourcompany.#{name}</string>}
-          f.puts %{	<key>CFBundleInfoDictionaryVersion</key>}
-          f.puts %{	<string>6.0</string>}
-          f.puts %{	<key>CFBundleName</key>}
-          f.puts %{	<string>#{name}</string>}
-          f.puts %{	<key>CFBundlePackageType</key>}
-          f.puts %{	<string>APPL</string>}
-          f.puts %{	<key>CFBundleSignature</key>}
-          f.puts %{	<string>????</string>}
-          f.puts %{	<key>CFBundleVersion</key>}
-          f.puts %{	<string>#{version}</string>}
-          f.puts %{	<key>NSPrincipalClass</key>}
-          f.puts %{	<string>NSApplication</string>}
-          f.puts %{</dict>}
-          f.puts %{</plist>}
-        end
+    def compile_data_models
+      data_models.each do |data|
+        `/Developer/usr/bin/momc #{data} #{resources_root}/#{File.basename(data, ".xcdatamodel")}.mom`
       end
-      
-      def build_executable
-        File.open(objective_c_source_file, "wb") do |f| 
-          f.puts %{
-            
-            #import <MacRuby/MacRuby.h>
-
-            int main(int argc, char *argv[])
-            {
-                return macruby_main("rb_main.rb", argc, argv);
-            }
+    end
+
+    def copy_icon_file
+      FileUtils.cp config.icon, icon_file
+    end
+
+    def write_pkg_info_file
+      File.open(pkg_info_file, 'wb') { |f| f.write "#{config.type}#{config.signature}" }
+    end
+
+    def write_info_plist_file
+      # http://developer.apple.com/library/mac/#documentation/General/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html%23//apple_ref/doc/uid/TP40009254-SW1
+      info = {
+        CFBundleName:                  config.name,
+        CFBundleIdentifier:            config.identifier,
+        CFBundleVersion:               config.version,
+        CFBundlePackageType:           config.type,
+        CFBundleSignature:             config.signature,
+        CFBundleExecutable:            objective_c_executable_file,
+        CFBundleDevelopmentRegion:     'English',
+        CFBundleInfoDictionaryVersion: '6.0',
+        NSPrincipalClass:              'NSApplication',
+        LSUIElement:                   config.agent,
+        LSMinimumSystemVersion:        '10.6.7', # should match MacRuby
+      }
+      info[:CFBundleIconFile] = File.basename(config.icon) if config.icon_exists?
+
+      File.open(info_plist_file, 'w') { |f| f.write info.to_plist }
+    end
+
+    def embed_framework # and also gems
+      options = config.stdlib ? '' : '--no-stdlib '
+      config.gems.each { |gem| options << "--gem #{gem} " }
+      options << '--bs ' if config.embed_bs?
+      puts `macruby_deploy --embed --gem hotcocoa #{options} #{bundle_root}`
+    end
+
+    # @todo something better than puts `gcc`
+    def build_executable
+      File.open(objective_c_source_file, 'wb') do |f|
+        f.write %{
+          #import <MacRuby/MacRuby.h>
+
+          int main(int argc, char *argv[])
+          {
+              return macruby_main("rb_main.rb", argc, argv);
           }
-        end
-        archs = RUBY_ARCH.include?('ppc') ? '-arch ppc' : '-arch i386 -arch x86_64'
-        puts `cd "#{macos_root}" && gcc main.m -o #{objective_c_executable_file} #{archs} -framework MacRuby -framework Foundation -fobjc-gc-only`
-        File.unlink(objective_c_source_file)
-      end
-      
-      def write_ruby_main
-        File.open(main_ruby_source_file, "wb") do |f|
-          f.puts "$:.map! { |x| x.sub(/^\\/Library\\/Frameworks/, NSBundle.mainBundle.privateFrameworksPath) }" if deploy?
-          f.puts "$:.unshift NSBundle.mainBundle.resourcePath.fileSystemRepresentation"
-          f.puts "load '#{load_file}'"
-        end
-      end
-      
-      def bundle_root
-        "#{name}.app"
+        }
       end
-      
-      def contents_root
-        File.join(bundle_root, "Contents")
+      Dir.chdir(macos_root) do
+        puts `gcc main.m -o #{objective_c_executable_file} -arch x86_64 -framework MacRuby -framework Foundation -fobjc-gc-only`
       end
+      File.unlink(objective_c_source_file)
+    end
 
-      def frameworks_root
-        File.join(contents_root, "Frameworks")
-      end
-      
-      def macos_root
-        File.join(contents_root, "MacOS")
-      end
-      
-      def resources_root
-        File.join(contents_root, "Resources")
-      end
+    # Borrow rb_main from MacRuby Xcode templates
+    def write_ruby_main
+      File.open(main_ruby_source_file, 'wb') do |f|
+        f.write <<-EOF
+# Borrowed from the MacRuby sources on April 18, 2011
+framework 'Cocoa'
 
-      def bridgesupport_root
-        File.join(resources_root, "BridgeSupport")
-      end
-      
-      def info_plist_file
-        File.join(contents_root, "Info.plist")
-      end
-      
-      def icon_file
-        File.join(resources_root, "#{name}.icns")
-      end
-      
-      def pkg_info_file
-        File.join(contents_root, "PkgInfo")
-      end
-      
-      def objective_c_executable_file
-        name.gsub(/ /, '')
-      end
-      
-      def objective_c_source_file
-        File.join(macos_root, "main.m")
-      end
-      
-      def main_ruby_source_file
-        File.join(resources_root, "rb_main.rb")
-      end
-      
-      def current_macruby_version
-        NSFileManager.defaultManager.pathContentOfSymbolicLinkAtPath(File.join(macruby_versions_path, "Current"))
-      end
-      
-      def current_macruby_path
-        File.join(macruby_versions_path, current_macruby_version)
-      end
-      
-      def macruby_versions_path
-        File.join(macruby_framework_path, "Versions")
-      end
-      
-      def macruby_framework_path
-        "/Library/Frameworks/MacRuby.framework"
+# Loading all the Ruby project files.
+main = File.basename(__FILE__, File.extname(__FILE__))
+dir_path = NSBundle.mainBundle.resourcePath.fileSystemRepresentation
+dir_path += "/lib/"
+Dir.glob(File.join(dir_path, '*.{rb,rbo}')).map { |x| File.basename(x, File.extname(x)) }.uniq.each do |path|
+  if path != main
+    require File.join(dir_path, path)
+  end
+end
+
+# Starting the Cocoa main loop.
+NSApplicationMain(0, nil)
+        EOF
       end
+    end
 
+    def bundle_root
+      "#{config.name}.app"
+    end
+
+    def contents_root
+      File.join(bundle_root, "Contents")
+    end
+
+    def frameworks_root
+      File.join(contents_root, "Frameworks")
+    end
+
+    def macos_root
+      File.join(contents_root, "MacOS")
+    end
+
+    def resources_root
+      File.join(contents_root, "Resources")
+    end
+
+    def info_plist_file
+      File.join(contents_root, "Info.plist")
+    end
+
+    def icon_file
+      File.join(resources_root, "#{config.name}.icns")
+    end
+
+    def pkg_info_file
+      File.join(contents_root, "PkgInfo")
+    end
+
+    def objective_c_executable_file
+      config.name.gsub(/\s+/, '')
+    end
+
+    def objective_c_source_file
+      File.join(macos_root, "main.m")
+    end
+
+    def main_ruby_source_file
+      File.join(resources_root, "rb_main.rb")
+    end
   end
-  
 end