xcake 0.7.1 → 0.8.1

data/example/framework/Cakefile

@@ -0,0 +1,133 @@
+# https://github.com/jcampbell05/xcake
+# http://www.rubydoc.info/github/jcampbell05/xcake/master/file/docs/Cakefile.md
+
+iOSdeploymentTarget = "8.0"
+currentSwiftVersion = "3.0.1" # to set "Use Legacy Swift ..." to "No"
+companyIdentifier = "com.CakeMania"
+developmentTeamId = "XYZXYZ" # for automatic debug signing in Xcode 8
+testSuffix = "Tst"
+
+#===
+
+project.name = "CakeFamework"
+project.class_prefix = "CFW"
+project.organization = "CakeMania Inc."
+
+#=== DEFAULT target settings
+
+project.all_configurations.each do |configuration|
+
+    # for all configurations
+
+    configuration.settings["SDKROOT"] = "iphoneos"
+    configuration.settings["DEBUG_INFORMATION_FORMAT"] = "dwarf"
+    configuration.settings["CODE_SIGN_IDENTITY[sdk=iphoneos*]"] = "iPhone Developer"
+    configuration.settings["TARGETED_DEVICE_FAMILY"] = "1,2"
+    configuration.settings["IPHONEOS_DEPLOYMENT_TARGET"] = iOSdeploymentTarget
+    configuration.settings["VERSIONING_SYSTEM"] = "apple-generic"
+
+    configuration.settings["GCC_NO_COMMON_BLOCKS"] = "YES"
+    configuration.settings["GCC_WARN_ABOUT_RETURN_TYPE"] = "YES_ERROR"
+    configuration.settings["GCC_WARN_UNINITIALIZED_AUTOS"] = "YES_AGGRESSIVE"
+    configuration.settings["CLANG_WARN_DIRECT_OBJC_ISA_USAGE"] = "YES_ERROR"
+    configuration.settings["CLANG_WARN_OBJC_ROOT_CLASS"] = "YES_ERROR"
+
+    configuration.settings["SWIFT_OPTIMIZATION_LEVEL"] = "-Onone"
+
+    configuration.settings["CURRENT_PROJECT_VERSION"] = "1" # just default non-empty value
+
+    configuration.settings["CLANG_WARN_INFINITE_RECURSION"] = "YES" # Xcode 8
+    configuration.settings["CLANG_WARN_SUSPICIOUS_MOVE"] = "YES" # Xcode 8
+    configuration.settings["ENABLE_STRICT_OBJC_MSGSEND"] = "YES" # Xcode 8
+
+    #===
+
+    if configuration.name == "Release"
+
+        configuration.settings["DEBUG_INFORMATION_FORMAT"] = "dwarf-with-dsym"
+        configuration.settings["SWIFT_OPTIMIZATION_LEVEL"] = "-Owholemodule" # Xcode 8
+
+    end
+
+end
+
+#===
+
+# Imagine we have project folder structure like this:
+    #
+    # - Cakefile
+    # - Info/
+    # | - CakeFamework.plist
+    # | - CakeFameworkTst.plist
+    # - Src/
+    # | - ...
+    # - Tst/
+    # | - ...
+    #
+
+#=== TARGETS
+
+target do |target|
+
+    target.name = project.name
+    target.type = :framework
+    target.language = :swift
+    target.platform = :ios
+    target.deployment_target = iOSdeploymentTarget
+
+    #=== CUSTOM settings for the target
+
+    target.all_configurations.each do |configuration|
+
+        #=== Build Settings - Core
+
+        configuration.product_bundle_identifier = companyIdentifier + "." + target.name
+
+        configuration.settings["INFOPLIST_FILE"] = "Info/" + target.name + ".plist"
+
+        configuration.settings["PRODUCT_NAME"] = "$(TARGET_NAME)"
+
+        # Xcode 8 automati c signing support
+        configuration.settings["CODE_SIGN_IDENTITY[sdk=iphoneos*]"] = "iPhone Developer"
+        configuration.settings["DEVELOPMENT_TEAM"] = developmentTeamId
+
+        configuration.settings["SWIFT_VERSION"] = currentSwiftVersion # Xcode 8
+
+    end
+
+    #=== Source Files
+
+    # assume all source files are located inside "/Src" folder and its subfolders
+
+    target.include_files = ["Src/**/*.*"]
+
+    #=== TEST TARGETS
+    
+    unit_tests_for target do |test_target|
+        
+        test_target.name = target.name + testSuffix
+        test_target.deployment_target = iOSdeploymentTarget
+
+        test_target.all_configurations.each do |configuration|
+
+            configuration.product_bundle_identifier = companyIdentifier + "." + test_target.name
+
+            configuration.settings["INFOPLIST_FILE"] = "Info/" + test_target.name + ".plist"
+
+            configuration.settings["LD_RUNPATH_SEARCH_PATHS"] = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"
+
+            # Xcode 8 automati c signing support
+            configuration.settings["CODE_SIGN_IDENTITY[sdk=iphoneos*]"] = "iPhone Developer"
+            configuration.settings["DEVELOPMENT_TEAM"] = developmentTeamId
+
+            configuration.settings["SWIFT_VERSION"] = currentSwiftVersion # Xcode 8
+
+        end
+
+        #=== Source Files
+
+        test_target.include_files = [testSuffix + "/**/*.*"]
+
+    end
+
+end

data/gemfiles/Gemfile.xcodeproj-1.3.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xcake.gemspec
+gemspec :path => '..'
+gem "xcodeproj", "~> 1.3.0"

data/gemfiles/Gemfile.xcodeproj-1.4.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xcake.gemspec
+gemspec :path => '..'
+gem "xcodeproj", "~> 1.4.0"

data/gemfiles/Gemfile.xcodeproj-edge

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xcake.gemspec
+gemspec :path => '..'
+gem "xcodeproj", :git => 'https://github.com/CocoaPods/Xcodeproj'

data/lib/xcake/build_phase/headers_build_phase.rb

@@ -0,0 +1,47 @@
+module Xcake
+  PUBLIC_HEADER_ATTRIBUTE = { 'ATTRIBUTES' => ['Public'] }.freeze
+  PRIVATE_HEADER_ATTRIBUTE = { 'ATTRIBUTES' => ['Private'] }.freeze
+
+  # This class is used to represent a copy headers build phase
+  #
+  class HeadersBuildPhase < BuildPhase
+    attr_accessor :public
+    attr_accessor :private
+    attr_accessor :project
+
+    def initialize
+      @public = []
+      @private = []
+      @project = []
+
+      yield(self) if block_given?
+    end
+
+    def build_phase_type
+      Xcodeproj::Project::Object::PBXHeadersBuildPhase
+    end
+
+    def configure_native_build_phase(native_build_phase, context)
+      @public.each do |file|
+        file_reference = context.file_reference_for_path(file)
+        build_file = native_build_phase.add_file_reference(file_reference)
+        build_file.settings = PUBLIC_HEADER_ATTRIBUTE
+      end
+
+      @private.each do |file|
+        file_reference = context.file_reference_for_path(file)
+        build_file = native_build_phase.add_file_reference(file_reference)
+        build_file.settings = PRIVATE_HEADER_ATTRIBUTE
+      end
+
+      @project.each do |file|
+        file_reference = context.file_reference_for_path(file)
+        native_build_phase.add_file_reference(file_reference)
+      end
+    end
+
+    def to_s
+      'BuildPhase<Copy Headers>'
+    end
+  end
+end

data/lib/xcake/build_phase/shell_script_build_phase.rb

@@ -0,0 +1,24 @@
+module Xcake
+  # This class is used to represent a shell script build phase
+  #
+  class ShellScriptBuildPhase < BuildPhase
+    # The name of the build phase as shown in Xcode
+    attr_accessor :name
+
+    # String coataining the contents of the script to run
+    attr_accessor :script
+
+    def build_phase_type
+      Xcodeproj::Project::Object::PBXShellScriptBuildPhase
+    end
+
+    def configure_native_build_phase(native_build_phase, _context)
+      native_build_phase.name = name
+      native_build_phase.shell_script = script.strip_heredoc
+    end
+
+    def to_s
+      "BuildPhase<#{name}>"
+    end
+  end
+end

data/lib/xcake/build_phase.rb

@@ -0,0 +1,36 @@
+module Xcake
+  # This class is used to describe a build phase for a
+  # Xcode project; This forms part of the DSL
+  # and is usually stored in files named `Cakefile`.
+  #
+  class BuildPhase
+    # @param    [Proc] block
+    #           an optional block that configures the build phase through the DSL.
+    #
+    # @example  Creating a Build Phase.
+    #
+    #           BuildPhase.new do |p|
+    #             p.name "test"
+    #           end
+    #
+    def initialize
+      yield(self) if block_given?
+    end
+
+    # This method is called when generating the build phases
+    # subclasses should implement this to allow xcake to know
+    # what native build phase type this DSL Object represents
+    #
+    def build_phase_type
+      raise 'build_phase_type not implemented'
+    end
+
+    # This method is called when generating the build phases
+    # subclasses should implement this to handle the
+    # configuration of the build phase
+    #
+    def configure_native_build_phase(_native_build_phase, _context)
+      raise 'configure_native_build_phase not implemented'
+    end
+  end
+end

data/lib/xcake/constants.rb

@@ -0,0 +1,82 @@
+module Xcake
+  module Constants
+    COMMON_BUILD_SETTINGS = Xcodeproj::Constants::COMMON_BUILD_SETTINGS.deep_merge(
+      [:ios, :unit_test_bundle] => {
+        'LD_RUNPATH_SEARCH_PATHS' => [
+          '$(inherited)',
+          '@executable_path/Frameworks',
+          '@loader_path/Frameworks'
+        ]
+      }.freeze,
+      [:osx, :unit_test_bundle] => {
+        'LD_RUNPATH_SEARCH_PATHS' => [
+          '$(inherited)',
+          '@executable_path/../Frameworks',
+          '@loader_path/../Frameworks'
+        ]
+      }.freeze
+    ).freeze
+
+    PRODUCT_TYPE_UTI = Xcodeproj::Constants::PRODUCT_TYPE_UTI
+
+    # Returns the common build settings for a given platform and configuration
+    # name.
+    #
+    # @param  [Symbol] type
+    #         the type of the build configuration, can be `:release` or
+    #         `:debug`.
+    #
+    # @param  [Symbol] platform
+    #         the platform for the build settings, can be `:ios` or `:osx`.
+    #
+    # @param  [String] deployment_target
+    #         the deployment target for the platform.
+    #
+    # @param  [Symbol] target_product_type
+    #         the product type of the target, can be any of
+    #         `Constants::PRODUCT_TYPE_UTI.values`
+    #         or `Constants::PRODUCT_TYPE_UTI.keys`. Default is :application.
+    #
+    # @param  [Symbol] language
+    #         the primary language of the target, can be `:objc` or `:swift`.
+    #
+    # @return [Hash] The common build settings
+    #
+    def self.common_build_settings(type, platform = nil, deployment_target = nil, target_product_type = nil, language = :objc)
+      target_product_type = (PRODUCT_TYPE_UTI.find { |_, v| v == target_product_type } || [target_product_type || :application])[0]
+      common_settings = COMMON_BUILD_SETTINGS
+
+      # Use intersecting settings for all key sets as base
+      settings = deep_dup(common_settings[:all])
+
+      # Match further common settings by key sets
+      keys = [type, platform, target_product_type, language].compact
+      key_combinations = (1..keys.length).flat_map { |n| keys.combination(n).to_a }
+      key_combinations.each do |key_combination|
+        settings.merge!(deep_dup(common_settings[key_combination] || {}))
+      end
+
+      if deployment_target
+        case platform
+        when :ios then settings['IPHONEOS_DEPLOYMENT_TARGET'] = deployment_target
+        when :osx then settings['MACOSX_DEPLOYMENT_TARGET'] = deployment_target
+        when :tvos then settings['TVOS_DEPLOYMENT_TARGET'] = deployment_target
+        when :watchos then settings['WATCHOS_DEPLOYMENT_TARGET'] = deployment_target
+        end
+      end
+
+      settings
+    end
+
+    # Creates a deep copy of the given object
+    #
+    # @param  [Object] object
+    #         the object to copy.
+    #
+    # @return [Object] The deeply copy of the obejct object.
+    #
+    def self.deep_dup(object)
+      Xcodeproj::Project::ProjectHelper.deep_dup(object)
+    end
+  end
+end

data/lib/xcake/context/xcodeproj_context.rb

@@ -9,6 +9,8 @@ module Xcake
 
     def create_object_for(dsl_object)
       case dsl_object
+      when BuildPhase
+        create_object_for_build_phase(dsl_object)
       when Project
         create_object_for_project(dsl_object)
       when Target
@@ -20,6 +22,10 @@ module Xcake
       end
     end
 
+    def create_object_for_build_phase(build_phase)
+      @project.new(build_phase.build_phase_type)
+    end
+
     def create_object_for_project(project)
       @project = Xcode::Project.new("./#{project.name}.xcodeproj", true)
       @project.setup_for_xcake
@@ -42,5 +48,9 @@ module Xcake
       pathname = Pathname.new path
       @project.file_reference_for_path(pathname)
     end
+
+    def scheme_list
+      @scheme_list ||= Xcode::SchemeList.new(@project)
+    end
   end
 end

data/lib/xcake/context.rb

@@ -1,18 +1,42 @@
 require 'xcodeproj'
 
 module Xcake
+  # The Context is an object that tracking of native objects in the project
+  # format.
+  #
+  # It allows components of the Xcake generator system to retrieve the
+  # native representation of a DSL object which is useful for operations
+  # which require multiple steps.
+  #
+  # See XcodeprojContext and the Genrators for how this is used.
+  #
   module Context
+    # The internal hash of native objects reference by their
+    # related DSL object
+    #
     attr_accessor :object_hash
 
     def object_hash
       @object_hash ||= {}
     end
 
+    # This method returns or creates a native object
+    # for a DSL object
+    #
     def native_object_for(dsl_object)
       object_hash[dsl_object] ||= create_object_for(dsl_object)
     end
 
+    # This method returns or creates a file reference
+    # for a path
+    #
     def file_reference_for_path(path)
     end
+
+    # This method returns or creates a scheme list for
+    # the project
+    #
+    def scheme_list
+    end
   end
 end

data/lib/xcake/generator/scheme_generator.rb

@@ -4,11 +4,22 @@ module Xcake
       [TargetGenerator, ConfigurationGenerator]
     end
 
-    def visit_project(project)
+    def visit_project(_project)
       EventHooks.run_hook :before_adding_user_schemes
+    end
+
+    def visit_target(target)
+      scheme_list = @context.scheme_list
+      native_target = @context.native_object_for(target)
 
+      scheme_list.create_schemes_for_target(native_target) unless native_target.test_target_type?
+    end
+
+    def leave_project(project)
+      scheme_list = @context.scheme_list
       native_project = @context.native_object_for(project)
-      native_project.recreate_user_schemes
+
+      scheme_list.save(native_project.path)
     end
   end
 end

data/lib/xcake/generator/target_build_phase_generator.rb

@@ -1,7 +1,7 @@
 module Xcake
-  # TODO: In future this should just infer extra targets and add it to the DSL
-  # we should then implement a 2nd pass generator which turns that DSL into
-  # build phases
+  # This generator generates the build phases for each target
+  # in the project
+  #
   class TargetBuildPhaseGenerator < Generator
     def self.dependencies
       [TargetGenerator, TargetDependencyGenerator]
@@ -12,6 +12,14 @@ module Xcake
 
       native_target = @context.native_object_for(target)
 
+      target.build_phases.each do |phase|
+        EventHooks.run_hook :before_adding_custom_build_phase, phase, target
+
+        native_build_phase = @context.native_object_for(phase)
+        phase.configure_native_build_phase(native_build_phase, @context)
+        native_target.build_phases << native_build_phase
+      end
+
       target.target_dependencies.each do |dep|
         native_dep = @context.native_object_for(dep)
 

data/lib/xcake/generator/target_dependency_generator.rb

@@ -1,7 +1,7 @@
 module Xcake
   class TargetDependencyGenerator < Generator
     def self.dependencies
-      [TargetGenerator]
+      [TargetGenerator, TargetLinkGenerator]
     end
 
     def visit_target(target)

data/lib/xcake/generator/target_file_reference_generator.rb

@@ -14,13 +14,12 @@ module Xcake
     end
 
     def visit_target(target)
-
-      paths_to_include = Dir.glob(target.include_files).map { |f|
+      paths_to_include = Dir.glob(target.include_files).map do |f|
         Pathname.new(f).cleanpath.to_s
-      }
-      paths_to_exclude = Dir.glob(target.exclude_files).map { |f|
+      end
+      paths_to_exclude = Dir.glob(target.exclude_files).map do |f|
         Pathname.new(f).cleanpath.to_s
-      }
+      end
 
       paths = paths_to_include - paths_to_exclude
       paths.each do |p|

data/lib/xcake/generator/target_link_generator.rb

@@ -0,0 +1,25 @@
+module Xcake
+  # This generator handles linking targets
+  # specified as being linked in the Cakefile
+  #
+  class TargetLinkGenerator < Generator
+    def self.dependencies
+      [TargetGenerator]
+    end
+
+    def visit_target(target)
+      return if target.linked_targets.empty?
+
+      native_target = @context.native_object_for(target)
+      frameworks_build_phase = native_target.frameworks_build_phase
+
+      target.linked_targets.each do |linked_target|
+        native_linked_target = @context.native_object_for(linked_target)
+        target.target_dependencies << linked_target
+
+        linked_product = native_linked_target.product_reference
+        frameworks_build_phase.add_file_reference(linked_product)
+      end
+    end
+  end
+end

data/lib/xcake/informative.rb

@@ -1,6 +1,5 @@
 require 'claide'
 
-# TODO: Hook into UI Class somehow.
 module Xcake
   class Informative < StandardError
     include CLAide::InformativeError

data/lib/xcake/path_classifier.rb

@@ -5,10 +5,10 @@ module Xcake
   #
   class PathClassifier
     EXTENSION_MAPPINGS = {
-      PBXFrameworksBuildPhase: %w{.a .dylib .so .framework}.freeze,
-      PBXHeadersBuildPhase: %w{.h .hpp}.freeze,
-      PBXSourcesBuildPhase: %w{.c .m .mm .cpp .swift .xcdatamodeld}.freeze,
-      PBXResourcesBuildPhase: %w{.xcassets}.freeze
+      PBXFrameworksBuildPhase: %w(.a .dylib .so .framework).freeze,
+      PBXHeadersBuildPhase: %w(.h .hpp).freeze,
+      PBXSourcesBuildPhase: %w(.c .m .mm .cpp .swift .xcdatamodeld).freeze,
+      PBXResourcesBuildPhase: %w(.xcassets).freeze
     }.freeze
 
     # @note This should be overidden
@@ -27,7 +27,7 @@ module Xcake
 
     def self.classification_for_path(path)
       classification = EXTENSION_MAPPINGS.detect do |_key, ext_group|
-        ext_group.any? {|ext| File.extname(path) == ext}
+        ext_group.any? { |ext| File.extname(path) == ext }
       end
 
       return :PBXResourcesBuildPhase if classification.nil?

data/lib/xcake/project/sugar.rb

@@ -94,11 +94,13 @@ module Xcake
       test_target.language = host_target.language
 
       host_path = "#{host_target.name}.app/#{host_target.name}"
-      test_target.all_configurations.each do |c|
-        c.settings['TEST_HOST'] = "$(BUILT_PRODUCTS_DIR)/#{host_path}"
-      end
-      test_target.all_configurations.each do |c|
-        c.settings['BUNDLE_LOADER'] = '$(TEST_HOST)'
+
+      # TODO: Custom Xcode setting constant
+      if host_target.type == :application
+        test_target.all_configurations.each do |c|
+          c.settings['TEST_HOST'] = "$(BUILT_PRODUCTS_DIR)/#{host_path}"
+          c.settings['BUNDLE_LOADER'] = '$(TEST_HOST)'
+        end
       end
     end
 

data/lib/xcake/project.rb

@@ -13,7 +13,6 @@ module Xcake
 
     # @!group Configuring a project
 
-    # TODO: Rename to name
     # @return [String] the name of the project file. This is used as
     #                  the filename.
     #

data/lib/xcake/target/configurable.rb

@@ -4,10 +4,6 @@ module Xcake
       @project
     end
 
-    # TODO: Move this to a constant, maybe Xcodeproj ones should be brought
-    # into here?
-    #
-    # Perhaps these could be made into a Gem itself?
     def default_settings
       {
         'INFOPLIST_FILE' => "#{name}/Supporting Files/Info.plist"
@@ -15,7 +11,7 @@ module Xcake
     end
 
     def default_debug_settings
-      Xcodeproj::Project::ProjectHelper
+      Xcake::Constants
         .common_build_settings(:debug,
                                platform,
                                deployment_target.to_s,
@@ -26,7 +22,7 @@ module Xcake
     end
 
     def default_release_settings
-      Xcodeproj::Project::ProjectHelper
+      Xcake::Constants
         .common_build_settings(:release,
                                platform,
                                deployment_target.to_s,

data/lib/xcake/target/sugar.rb

@@ -2,10 +2,35 @@ require 'xcodeproj'
 
 module Xcake
   class Target
-    def shell_script_build_phase(name, script)
-      phase = ShellScriptBuildPhase.new
+    # Creates a new Copy Headers build phase for the
+    # target
+    #
+    # @param  [Proc] block
+    #         an optional block that configures the build phase through the DSL.
+    #
+    # @return [HeadersBuildPhase] the new xcode build phase
+    #
+    def headers_build_phase(&block)
+      phase = HeadersBuildPhase.new(&block)
+      build_phases << phase
+      phase
+    end
+
+    # Creates a new Shell Script build phase for the
+    # target
+    #
+    # @param   [String] name
+    #          the name to use for the build phase
+    #
+    # @param   [Proc] block
+    #          an optional block that configures the build phase through the DSL.
+    #
+    # @return [ShellScriptBuildPhase] the new xcode build phase
+    #
+    def shell_script_build_phase(name, script, &block)
+      phase = ShellScriptBuildPhase.new(&block)
       phase.name = name
-      phase.script = script.strip_heredoc
+      phase.script = script
       build_phases << phase
       phase
     end