xcake 0.6.25 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 954f88b7b00bed7c70662f39af63a8c6b03aebd6
-  data.tar.gz: fc1dd6a7398f63d11e4a11187f5dcd4da9c19750
+  metadata.gz: 59b934c91bcb37c5f0d097d51c3e7a0871a9f1de
+  data.tar.gz: 50b91a77213c6682a9eafae98400a62b09f04883
 SHA512:
-  metadata.gz: 813a3b569f4aeb7090c941b0084c0a26aeb4cb14939f1728fd670c4f6764f0593aa85fe65e644c4ea31df148fcb87ff168f54112dea9bd0798ade3de6cf19917
-  data.tar.gz: 3d5839b23f3c8bafdff8ae861caab2c710d69819c2522a31cda9e30294757bfa75ae45e3c7258c77e346417eda8f6cc2dd390f11df7c0da0f251b738c9294f9d
+  metadata.gz: 7288c8d779b598cf328b77635dc16e5c183c00a2e7765691b96f261b7dfabb0547c6bc199bc3420bbf09e6981995f0aed71735418d2878e2f44e39a16e105866
+  data.tar.gz: 4eb8286ac978fc3cce5556e363fd2419a16b71a3306183219ed2db619063eac195f66a6f080383b3dac7afd70da3366cff15c344a0e991a4323cc34b3ad375c6

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+v0.7.0
+======
+- Simplified Target File Reference Generator.
+- Adds support for UI Tests.
+- Adds sample Cakefile to documentation.
+- Adds support for extension targets.
+
 v0.6.25
 =======
 - Fixed bug where Xcake would set incorrect path for a group of a Localized file.
@@ -117,6 +124,7 @@ v0.6.1
 v0.6.0
 ======
 - Infers build phases for the apple watch.
+- Re-engineered generator infastructure.
 - Fixes bug where configurations lacked a name when using shorthand syntax. (Thanks to @colinta).
 - Adds support for custom script build phases (Thanks to @colinta).
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xcake (0.6.25)
+    xcake (0.7.0)
       activesupport (< 5)
       claide (>= 0.9.1, < 2.0)
       cork
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.6)
+    activesupport (4.2.7.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -21,14 +21,14 @@ GEM
     claide (1.0.0)
     coderay (1.1.1)
     colored (1.2)
-    cork (0.1.0)
+    cork (0.2.0)
       colored (~> 1.2)
-    coveralls (0.8.14)
+    coveralls (0.8.15)
       json (>= 1.8, < 3)
       simplecov (~> 0.12.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
-      tins (~> 1.6.0)
+      tins (>= 1.6.0, < 2)
     diff-lcs (1.2.5)
     docile (1.1.5)
     hooks (0.4.1)
@@ -40,7 +40,7 @@ GEM
     parser (2.3.1.2)
       ast (~> 2.2)
     powerpack (0.1.1)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
@@ -59,7 +59,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.41.1)
+    rubocop (0.42.0)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
@@ -78,16 +78,16 @@ GEM
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.5)
-    tins (1.6.0)
+    tins (1.12.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     uber (0.0.15)
     unicode-display_width (1.1.0)
-    xcodeproj (1.1.0)
+    xcodeproj (1.2.0)
       activesupport (>= 3)
       claide (>= 1.0.0, < 2.0)
       colored (~> 1.2)
-    yard (0.9.0)
+    yard (0.9.5)
 
 PLATFORMS
   ruby

data/README.md

@@ -95,6 +95,10 @@ Usually you'll use xcake by running the command
 
 Xcake will then generate a Xcode project based on your Cakefile
 
+## Sample Cakefile
+
+To get better understanding of how to start using Xcake in a real project, see sample [Cakefile](https://github.com/jcampbell05/xcake/blob/master/docs/Sample/Cakefile).
+
 ## Need help?
 Please submit an issue on GitHub and provide information about your setup
 

data/bin/xcake

@@ -2,6 +2,6 @@
 
 require 'xcake'
 
-#TODO: Make UI and EventHooks DI-able
+# TODO: Make UI and EventHooks DI-able
 Xcake::UI.register_ui_hooks
 Xcake::Command.run(ARGV)

data/docs/Cakefile.md

@@ -1,4 +1,4 @@
-#Cakefile Syntax Reference
+# Cakefile Syntax Reference
 
 The `Cakefile` contains a lightweight DSL which provides the instructions on how to generate
 a project file. We adopt the convention over configuration and thus it can be very simple:
@@ -92,7 +92,7 @@ Mac App:
 application_for :mac, 8.0
 ```
 
-###Tests
+### Tests
 
 We can also specify a testing targets for other targets as well:
 
@@ -115,13 +115,32 @@ application_for :mac, 8.0 do |target|
         test_target.include_files = ["Tests/**/*.*"]
 
         # configure any other target-related properties
-        # as you would do with normal target
+        # as you would do with application target
 
     end
 end
 ```
 
-###Watch
+### UI Tests
+
+To create UI tests target, you do everything the same as for unit tests, but instead of "unit_tests_for" use "ui_tests_for", like this:
+
+```ruby
+application_for :mac, 8.0 do |target|
+
+  ui_tests_for target do |test_target|
+
+        test_target.name = "MyAwesomeUITests"
+        test_target.include_files = ["UITests/**/*.*"]
+
+        # configure any other target-related properties
+        # as you would do with application target
+
+    end
+end
+```
+
+### Watch
 
 To create watch applications we can simply use the `watch_app_for` method:
 

data/docs/Sample/Cakefile

@@ -0,0 +1,365 @@
+# https://github.com/jcampbell05/xcake
+# http://www.rubydoc.info/github/jcampbell05/xcake/master/file/docs/Cakefile.md
+
+# this is a sample Cakefile for a fictional project that is called "CakeMania"
+
+#===
+
+# lets define high level project settings
+
+project.name = "CakeMania"
+project.class_prefix = "CMN"
+project.organization = "CakeMania Inc."
+
+#===
+
+# Below we explicitly define the list of project build configurations.
+# If you do not define it explicitly, Xcake will implicitly define default ones,
+# that are equivalent to this:
+#
+# project.debug_configuration :Debug
+# project.release_configuration :Release
+#
+
+project.debug_configuration :Debug # for local development/debugging only, pointing to "test.*" API server
+project.release_configuration :Staging # for alpha and beta AdHoc builds, pointing to "test.*" API server
+project.release_configuration :RC # for release candidate AdHoc builds, pointing to "rc.*" API server
+project.release_configuration :Production # for App Store ready AdHoc builds, pointing to "www." API server
+project.release_configuration :AppStore # for App Store builds, pointing to "www." API server
+
+# Note, that Xcake will also automatically create set of project "Schemes" -
+# one for each build configuration, their names will be constructed from 
+# project name and configuration name, separated by dash, like this:
+#
+# "<project_name>-<configuration_name>"
+#
+# NOTE: every scheme will have the same build configiuration
+# for all phases (Run, Test, Profile, Archive). If you need different build configurations
+# based on phase - lets say one configuration for Run, but different one for Archive -
+# consider to have different build configurations (and as result - build shemes) for these purposes
+# (as proposed in this sample file).
+#
+# For this example, shemes will be:
+#
+# "CakeMania-Debug"
+# "CakeMania-Staging"
+# "CakeMania-RC"
+# "CakeMania-Production"
+# "CakeMania-AppStore"
+
+#===
+
+# Below we define "project level" build configurations.
+# REMEMBER this entiire file is just an interpretable script,
+# and the structure below is just a loop.
+# At every iteration we have reference to one
+# of the build configurations defined above explicitly or implicitly.
+
+# In this case, we set the same build settings to each configuration,
+# but, if we need to have some settings to be different for different
+# configurations, then you can use "if" expression to set different build settings
+# dependiong on "configuration.name" (we will see example of that in target settings below in this document).
+
+project.all_configurations.each do |configuration|
+
+    # the settings listed below are just a copy
+    # of what Xcode sets explicitly in a newly created Xcode
+    # project file in comparison with default values
+    # (the values that are marked with bold font).
+
+    configuration.settings["ENABLE_BITCODE"] = "YES"
+
+    configuration.settings["SDKROOT"] = "iphoneos"
+    configuration.settings["GCC_DYNAMIC_NO_PIC"] = "NO"
+    configuration.settings["OTHER_CFLAGS"] = "$(inherited) -DNS_BLOCK_ASSERTIONS=1"
+    configuration.settings["GCC_C_LANGUAGE_STANDARD"] = "gnu99"
+    configuration.settings["CLANG_ENABLE_MODULES"] = "YES"
+    configuration.settings["CLANG_ENABLE_OBJC_ARC"] = "YES"
+    configuration.settings["ENABLE_NS_ASSERTIONS"] = "NO"
+    configuration.settings["ENABLE_STRICT_OBJC_MSGSEND"] = "YES"
+    configuration.settings["CLANG_WARN_EMPTY_BODY"] = "YES"
+    configuration.settings["CLANG_WARN_BOOL_CONVERSION"] = "YES"
+    configuration.settings["CLANG_WARN_CONSTANT_CONVERSION"] = "YES"
+    configuration.settings["GCC_WARN_64_TO_32_BIT_CONVERSION"] = "YES"
+    configuration.settings["CLANG_WARN_INT_CONVERSION"] = "YES"
+    configuration.settings["GCC_WARN_ABOUT_RETURN_TYPE"] = "YES_ERROR"
+    configuration.settings["GCC_WARN_UNINITIALIZED_AUTOS"] = "YES_AGGRESSIVE"
+    configuration.settings["CLANG_WARN_UNREACHABLE_CODE"] = "YES"
+    configuration.settings["GCC_WARN_UNUSED_FUNCTION"] = "YES"
+    configuration.settings["GCC_WARN_UNUSED_VARIABLE"] = "YES"
+    configuration.settings["CLANG_WARN_DIRECT_OBJC_ISA_USAGE"] = "YES_ERROR"
+    configuration.settings["CLANG_WARN__DUPLICATE_METHOD_MATCH"] = "YES"
+    configuration.settings["GCC_WARN_UNDECLARED_SELECTOR"] = "YES"
+    configuration.settings["CLANG_WARN_OBJC_ROOT_CLASS"] = "YES_ERROR"
+    configuration.settings["DEFINES_MODULE"] = "YES" # http://stackoverflow.com/a/27251979
+
+    configuration.settings["CURRENT_PROJECT_VERSION"] = "1" # just default non-empty value
+
+end
+
+#=== 3d-party integration keys (global variables)
+
+# The values below will be used to set "user-defined" build settings
+# for build configurations on target level,
+# so we can reuse the same, lets say, "test" FB key
+# within several "test" configurations (for example, the same test key
+# would be used for "Debug" and "Staging" configurations), and can easily
+# see what is the value/key we use for testing and production,
+# and even update it in future if needed.
+
+# "FACEBOOK_KEY"
+
+facebookProdKey = "888888888888888"
+facebookTestKey = "999999999999999"
+
+#=== Targets
+
+# So far, we've defined poject settings and
+# project level build configuration settings
+# (which define defaults for target level build configurations).
+#
+# Now it's time to define target-level build settings.
+
+# Below we define "application"-type target and
+# put all it's settings (including definition or related unit test targets)
+# inside "application_for ... do ... end" structure.
+
+application_for :ios, 8.0 do |target|
+
+    # first of all, we set target settings
+
+    target.name = "CakeMania"
+    target.language = :swift
+
+    #===
+
+    # Now lets set target-level build settigns.
+    # Again, the structure below is just a loop,
+    # everything between "target.all_configurations.each do |configuration|"
+    # and corresponding "end" (see below on the same level in the very bottom of the file)
+    # is body of this loop, that repeats every iteration. This loop goes through
+    # the list of build configurations (defined above) and on each iteration
+    # we have variable "configuration" that contains reference to one
+    # of the build configurations in CONTEXT of the TARGET. This is equivalent of setting
+    # build settings on target-level in Xcode (you can access it if you choose to
+    # see build settigns by "Levels", not "Combined").
+
+    # Imagine we have project folder structure like this:
+    #
+    # - Cakefile
+    # - Info/
+    # | - CakeMania.plist
+    # | - CakeManiaTests.plist
+    # | - CakeManiaUITests.plist
+    # - Src/
+    # | - ...
+    # | - ObjC/
+    #   | - Prefix.pch
+    #   | - CakeMania-Bridging-Header.h
+    # | - ...
+    # - Res/
+    # | - CakeMania.entitlements
+    # | - CakeMania-test.entitlements
+    # | - ...
+    # | - CakeMania.xcassets/
+    #   | - ...
+    #   | - AppIcon.appiconset/
+    #     | - ...
+    #   | - Brand Assets.launchimage/
+    #     | - ...
+    #   | - ...
+    # - Lib/
+    # | - ...
+    # - Tst/
+    # | - ...
+    # - UITst/
+    # | - ...
+    #
+
+    target.all_configurations.each do |configuration|
+
+        #=== Build Settings - Core
+
+        configuration.product_bundle_identifier = "com.CakeMania.theApp"
+
+        configuration.settings["INFOPLIST_FILE"] = "Info/CakeMania.plist"
+
+        configuration.settings["PRODUCT_NAME"] = "$(TARGET_NAME)"
+        configuration.settings["CODE_SIGN_ENTITLEMENTS"] = "Res/CakeMania.entitlements"
+        configuration.settings["GCC_PREFIX_HEADER"] = "Src/ObjC/Prefix.pch"
+        # configuration.settings["FRAMEWORK_SEARCH_PATHS"] = "$(inherited)"
+        configuration.settings["LIBRARY_SEARCH_PATHS"] = "$(inherited) $(SRCROOT)/Lib/**"
+        configuration.settings["ASSETCATALOG_COMPILER_APPICON_NAME"] = "AppIcon"
+        configuration.settings["ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME"] = "Brand Assets"
+        configuration.settings["SWIFT_OBJC_BRIDGING_HEADER"] = "Src/ObjC/CakeMania-Bridging-Header.h"
+        configuration.settings["OTHER_LDFLAGS"] = "$(inherited) -ObjC"
+
+        # make configuration name available in run time:
+        configNameFlag = "CONFIG_" + configuration.name.upcase
+        configuration.settings["GCC_PREPROCESSOR_DEFINITIONS"] = "$(inherited) " + configNameFlag + "=1" # Obj-C support
+        configuration.settings["OTHER_SWIFT_FLAGS"] = "$(inherited) -D" + configNameFlag # Swift support
+        
+        # This will show "Automatic" in Xcode,
+        # relies on proper/valid "PROVISIONING_PROFILE" value:
+        configuration.settings["CODE_SIGN_IDENTITY[sdk=iphoneos*]"] = nil
+
+        #=== Build Settings - Per-configuration
+
+        # NOTE: any configuration-specific settings below will override
+        # common settings that you already applied above inside this
+        # "target.all_configurations.each do |configuration|" block
+
+        if configuration.name == "Debug"
+
+            #=== Config
+
+            configuration.settings["PROVISIONING_PROFILE"] = "f39ljkcf-2be6-49ee-8088-5741718g0969" # dev
+
+            configuration.settings["CODE_SIGN_ENTITLEMENTS"] = "Res/CakeMania-test.entitlements"
+
+            #=== Config - User Defined Build Settings
+            
+            configuration.settings["BRANCH_KEY"] = branchTestKey
+            configuration.settings["FACEBOOK_KEY"] = facebookTestKey
+
+        end
+
+        #===
+
+        if configuration.name == "Staging"
+
+            #=== Config
+    
+            configuration.settings["PROVISIONING_PROFILE"] = "19701b9a-p784-4476-ac01-af327a8deea8" # AdHoc
+
+            configuration.settings["CODE_SIGN_ENTITLEMENTS"] = "Res/CakeMania-test.entitlements"
+            
+            #=== Config - User Defined Build Settings
+            
+            configuration.settings["FACEBOOK_KEY"] = facebookTestKey
+
+        end
+
+        #===
+
+        if configuration.name == "RC"
+
+            #=== Config
+        
+            configuration.settings["PROVISIONING_PROFILE"] = "19701b9a-p784-4476-ac01-af327a8deea8" # AdHoc
+
+            configuration.settings["CODE_SIGN_ENTITLEMENTS"] = "Res/CakeMania-test.entitlements"
+            
+            #=== Config - User Defined Build Settings
+            
+            configuration.settings["FACEBOOK_KEY"] = facebookTestKey
+
+        end
+
+        #===
+
+        if configuration.name == "Production"
+
+            #=== Config
+        
+            configuration.settings["PROVISIONING_PROFILE"] = "19701b9a-p784-4476-ac01-af327a8deea8" # AdHoc
+
+            #=== Config - User Defined Build Settings
+            
+            configuration.settings["FACEBOOK_KEY"] = facebookProdKey
+
+        end
+
+        #===
+
+        if configuration.name == "AppStore"
+
+            #=== Config
+        
+            configuration.settings["PROVISIONING_PROFILE"] = "ba8502ed-6d0b-4aab-07do-61a7ad4dd5cb" # App Store
+
+            #=== Config - User Defined Build Settings
+
+            configuration.settings["FACEBOOK_KEY"] = facebookProdKey
+
+        end
+
+    end
+
+    #=== Extra System Frameworks
+
+    # Here is how we tell Xcake to include Apple system framework
+    # into the target.
+
+    # NOTE: "target.system_frameworks" is an array, that always have at least
+    # "Foundation" and "UIKit", os it's always non-empty and we should not initialize it
+    # before adding something there, so we jsut add values, one at a time (one per each line below).
+
+    target.system_frameworks << "AdSupport"
+    target.system_frameworks << "QuartzCore"
+
+    #=== Source Files
+
+    # Here is how we tell Xcake where to look for source files
+    # which need to be added into the target. Moreover, the folder struture
+    # will be re-created with Xcode groups.
+
+    # NOTE: "target.include_files" is an array, that is empty by default
+    # (no source files will be added to the target). So it's our responsibility
+    # to initialize this array (with "=" operand) before adding values/elements
+    # into it (with "<<" operand). Remember, this file is a Ruby script, and
+    # that's just how Ruby works.
+
+    target.include_files = ["Src/**/*.*"] # initialize array with 1 element
+    target.include_files << "Lib/**/*.*"  # add value into already non-empty array
+
+    target.include_files << "Res/**/*.*"  # add another value
+
+    #=== Tests
+    
+    # Below we define unit tests target for the application target.
+    # "unit_tests_for" is a reserved word, then you put variable that contains reference
+    # to the application target that you want to create unit tests for, it's "target" in our case.
+    # The "test_target" is reference to the newly created unit test target
+    # so we can configure it as we want - set name, build configurations (at least info plist file)
+    # and its source files, or course. The rules of how we work with test target (set its settings)
+    # are the same, as we work with application target.
+
+    unit_tests_for target do |test_target|
+        
+        test_target.name = "CakeManiaTests"
+
+        test_target.all_configurations.each do |configuration|
+
+            configuration.settings["INFOPLIST_FILE"] = "Info/CakeManiaTests.plist"
+
+        end
+
+        #=== Source Files
+
+        test_target.include_files = ["Tst/**/*.*"] # we set array with 1 element here!
+
+    end
+
+    #===
+
+    # Below we define UI tests target for the application target.
+    # See https://github.com/jcampbell05/xcake/issues/44
+
+    ui_tests_for target do |test_target|
+
+        test_target.name = "CakeManiaUITests"
+
+        test_target.all_configurations.each do |configuration|
+
+            configuration.settings["INFOPLIST_FILE"] = "Info/CakeManiaUITests.plist"
+
+        end
+
+        #=== Source Files
+
+        test_target.include_files = ["UITst/**/*.*"] # we set array with 1 element here!
+
+    end
+
+end

data/lib/xcake/context/xcodeproj_context.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 require 'xcodeproj'
 
 module Xcake
@@ -16,13 +17,10 @@ module Xcake
         create_object_for_configuration(dsl_object)
       when Node
         create_object_for_node(dsl_object)
-      else
-        nil
       end
     end
 
     def create_object_for_project(project)
-      # TODO: Make setup of project testable
       @project = Xcode::Project.new("./#{project.name}.xcodeproj", true)
       @project.setup_for_xcake
       @project
@@ -41,7 +39,8 @@ module Xcake
     end
 
     def file_reference_for_path(path)
-      @project.reference_for_path(path) || @project.new_file_reference(path)
+      pathname = Pathname.new path
+      @project.file_reference_for_path(pathname)
     end
   end
 end

data/lib/xcake/generator/configuration_generator.rb

@@ -6,7 +6,7 @@ module Xcake
   #
   class ConfigurationGenerator < Generator
     def self.dependencies
-      [TargetGenerator, ProjectStructureGenerator, TargetFileReferenceGenerator]
+      [TargetGenerator, ProjectStructureGenerator]
     end
 
     def visit_project(project)

data/lib/xcake/generator/target_file_reference_generator.rb

@@ -1,51 +1,45 @@
+require 'pathname'
+
 module Xcake
+  # This generator processes the files to add to the project from the
+  # `include_files` and `exclude_files`
+  #
   class TargetFileReferenceGenerator < Generator
-    attr_accessor :root_node
-    attr_accessor :dependency_provider
-
     def initialize(context)
       @context = context
-      @root_node = Node.new
-
-      @dependency_provider = DependencyProvider.new(FileReferenceInstaller)
     end
 
     def self.dependencies
       [TargetGenerator]
     end
 
-    def process_files_for_target(target)
-      native_target = @context.native_object_for(target)
+    def visit_target(target)
 
-      Dir.glob(target.include_files).each do |file|
-        @root_node.create_children_with_path(file, native_target)
-      end if target.include_files
+      paths_to_include = Dir.glob(target.include_files).map { |f|
+        Pathname.new(f).cleanpath.to_s
+      }
+      paths_to_exclude = Dir.glob(target.exclude_files).map { |f|
+        Pathname.new(f).cleanpath.to_s
+      }
 
-      Dir.glob(target.exclude_files).each do |file|
-        @root_node.remove_children_with_path(file, native_target)
-      end if target.exclude_files
-    end
-
-    def visit_project(project)
-      project.targets.each do |target|
-        process_files_for_target(target)
+      paths = paths_to_include - paths_to_exclude
+      paths.each do |p|
+        include_file_for_path_and_target(p, target) if PathClassifier.should_include_path?(p)
       end
-
-      root_node.accept(self)
     end
 
-    def visit_node(node)
-      return unless node.path
+    private
 
-      EventHooks.run_hook :before_adding_file, node
+    def include_file_for_path_and_target(path, target)
+      file_reference = @context.file_reference_for_path(path)
+      native_target = @context.native_object_for(target)
 
-      installer_class = @dependency_provider.tsort.detect do |i|
-        i.can_install_node(node)
-      end
+      build_phase_symbol = PathClassifier.classification_for_path(path)
 
-      unless installer_class.nil?
-        installer = installer_class.new(context)
-        node.accept(installer)
+      if PathClassifier.should_create_build_phase_for_classification?(build_phase_symbol)
+        build_phase_class = Xcodeproj::Project::Object.const_get(build_phase_symbol)
+        build_phase = native_target.build_phase_by_class(build_phase_class)
+        build_phase.add_file_reference(file_reference)
       end
     end
   end

data/lib/xcake/informative.rb

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