xcake 0.7.1 → 0.8.1

data/lib/xcake/target.rb

@@ -1,7 +1,7 @@
 module Xcake
   # This class is used to describe a target for a
   # Xcode project; This forms part of the DSL
-  # and is usally stored in files named `Cakefile`.
+  # and is usually stored in files named `Cakefile`.
   #
   class Target
     include Configurable
@@ -36,8 +36,8 @@ module Xcake
     #
     attr_accessor :language
 
-    # @return [Array<Xcodeproj::Project::Object::AbstractBuildPhase>] the list
-    #                  of custom build phases for the project.
+    # @return [Array<BuildPhase>] the list
+    #                             of build phases for the project.
     #
     attr_accessor :build_phases
 
@@ -122,6 +122,10 @@ module Xcake
     #                           Supports regular expressions,
     #                           Defaults to: ["./<Target Name>/*\*/\*.*"]
     #
+    #
+    # @note Xcake defaults to including files in the folder with the same name as
+    #       the targt
+    #
     # @example
     #
     #     spec.include_files = "Classes/**/*.{h,m}"
@@ -162,8 +166,14 @@ module Xcake
     #
     attr_accessor :target_dependencies
 
+    # @return [Array<Target>] targets to link to, use this
+    #         when you want to use a library or framework target
+    #         in another target
+    #
+    attr_accessor :linked_targets
+
     # @param    [Proc] block
-    #           an optional block that configures the project through the DSL.
+    #           an optional block that configures the target through the DSL.
     #
     # @example  Creating a Target.
     #
@@ -173,29 +183,26 @@ module Xcake
     #
     def initialize(project)
       @project = project
+
       @build_phases = []
+      @exclude_files = []
+      @linked_targets = []
+      @system_libraries = []
+      @target_dependencies = []
 
       yield(self) if block_given?
     end
 
+    ## Getters
+
     def include_files
+      # Import files in folder with same name as target by default
       @include_files ||= ["./#{@name}/**/*.*"]
     end
 
-    def exclude_files
-      @exclude_files ||= []
-    end
-
     def system_frameworks
-      @system_frameworks ||= default_system_frameworks_for platform
-    end
-
-    def system_libraries
-      @system_libraries ||= []
-    end
-
-    def target_dependencies
-      @target_dependencies ||= []
+      # Use default frameworks by default
+      @system_frameworks ||= default_system_frameworks_for(platform)
     end
 
     # @!group Conversion
@@ -206,12 +213,21 @@ module Xcake
 
     protected
 
+    # Returns an array of default system frameworks
+    # to use for a given platform.
+    #
+    # @param    [Symbol] platform
+    #           platform the frameworks are for.
+    #
+    #
+    # @return [Array<String>] system frameworks to use
+    #
     def default_system_frameworks_for(platform)
       case platform
       when :ios
         %w(Foundation UIKit)
       when :osx
-        ['Cocoa']
+        %w(Cocoa)
       when :tvos
         %w(Foundation UIKit)
       when :watchos

data/lib/xcake/ui.rb

@@ -1,8 +1,5 @@
 require 'cork'
 
-# TODO: i18n this.
-# TODO: Different modes depending on --verbose, and CI
-# TODO: Split output and UI code into seperate concerns.
 module Xcake
   class UI
     def self.register_ui_hooks
@@ -69,7 +66,7 @@ module Xcake
       end
 
       EventHooks.before_adding_custom_build_phase do |phase, target|
-        board.puts "- Adding custom phase \"#{phase.name}\" for #{target}"
+        board.puts "- Adding \"#{phase}\" to #{target}"
       end
 
       EventHooks.before_adding_embed_watch_app_phase do

data/lib/xcake/version.rb

@@ -1,3 +1,3 @@
 module Xcake
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.8.1'.freeze
 end

data/lib/xcake/xcode/project.rb

@@ -2,6 +2,9 @@ require 'xcodeproj'
 
 module Xcake
   module Xcode
+    # Special subclass of the Xcodeproj::Project which adds capabilities and
+    # helper methods xcake need
+    #
     class Project < Xcodeproj::Project
       # @return [Hash] the attributes of
       #                the project
@@ -42,21 +45,10 @@ module Xcake
         attributes['ORGANIZATIONNAME'] = organization
       end
 
-      # @return [SchemeList] the scheme list
-      #
-      def scheme_list
-        @scheme_list ||= SchemeList.new(self)
-      end
-
       def object_version
         Xcodeproj::Constants::DEFAULT_OBJECT_VERSION.to_s
       end
 
-      def recreate_user_schemes(*)
-        scheme_list.recreate_schemes
-        scheme_list.save(path)
-      end
-
       # Configures the Project for use with Xcake.
       # This makes sure we have sensible defaults and
       # it as clean as possible.
@@ -114,7 +106,7 @@ module Xcake
         new(Xcodeproj::Project::Object::XCBuildConfiguration)
       end
 
-      # Creates a new xcode file reference from the node
+      # Creates a new xcode file reference for a path
       #
       # @param [Pathname] path
       # =>                path of the file reference from the source root
@@ -124,11 +116,21 @@ module Xcake
       def file_reference_for_path(path)
         group = group_for_file_reference_path(path)
         group_path = Pathname.new group.dirname
-
         file_path = path.cleanpath.relative_path_from group_path
+
+        ref = group.find_file_by_path file_path.to_s
+        return ref if ref
+
         group.new_reference(file_path.to_s)
       end
 
+      # Finds or Creates a new xcode group for a path
+      #
+      # @param [Pathname] path
+      # =>                path of the group from the source root
+      #
+      # @return [PBXGroup] existing or new xcode group
+      #
       def group_for_file_reference_path(path)
         clean_path = path.cleanpath
         group = variant_group_for_path(path)
@@ -138,6 +140,16 @@ module Xcake
 
       private
 
+      # Creates or finds a new xcode variant group for a path
+      #
+      # @note this method will return nil if the path isn't a valid
+      # variant group path
+      #
+      # @param [Pathname] path
+      # =>                path of the variant group from the source root
+      #
+      # @return [PBXVariantGroup] existing or new xcode variant group
+      #
       def variant_group_for_path(path)
         group_path = path.dirname.cleanpath
         base_name = group_path.basename

data/lib/xcake/xcode/scheme.rb

@@ -2,6 +2,9 @@ require 'xcodeproj'
 
 module Xcake
   module Xcode
+    # Special subclass of the Xcodeproj::XCScheme which adds capabilities and
+    # helper methods xcake need
+    #
     class Scheme < Xcodeproj::XCScheme
       # @return  [String] name for the scheme.
       #

data/lib/xcake/xcode/scheme_list.rb

@@ -33,32 +33,12 @@ module Xcake
         }
       end
 
-      # Creates the schemes based on the targets.
-      #
-      def recreate_schemes
-        @project.targets.each do |t|
-          create_schemes_for_target(t)
-        end
-      end
-
       # Creates schemes based on a target.
       #
       # @param    [Target] target
       #           target to create schemes for
       #
       def create_schemes_for_target(target)
-        case target.product_type
-        when Xcodeproj::Constants::PRODUCT_TYPE_UTI[:application]
-          create_schemes_for_application(target)
-        end
-      end
-
-      # Creates schemes based on a application target
-      #
-      # @param    [Target] target
-      #           target to create application schemes for
-      #
-      def create_schemes_for_application(target)
         target.build_configurations.each do |c|
           scheme = Scheme.new
 
@@ -74,7 +54,6 @@ module Xcake
           scheme.analyze_action.build_configuration = c.name
           scheme.archive_action.build_configuration = c.name
 
-          # TODO: We should structure this stuff out
           if unit_test_target
             unit_test_target.add_dependency(target)
             @xcschememanagement['SuppressBuildableAutocreation'][unit_test_target.uuid] = { 'primary' => true }
@@ -89,8 +68,6 @@ module Xcake
       # @param    [String] writing_path
       #           path to write to.
       #
-      # TODO: Move to a Generator
-      #
       def save(writing_path)
         schemes_dir = Scheme.user_data_dir(writing_path)
 

data/lib/xcake/xcodeproj_ext/PBXGroup.rb

@@ -25,12 +25,12 @@ module Xcodeproj
        end
 
         def dirname
-          return "." if parent.is_a? Xcake::Xcode::Project
-          return "." if parent.is_a? PBXProject
+          return '.' if parent.is_a? Xcake::Xcode::Project
+          return '.' if parent.is_a? PBXProject
           return parent.dirname.to_s if is_a? PBXVariantGroup
 
           if display_name
-            "#{parent.dirname.to_s}/#{display_name}"
+            "#{parent.dirname}/#{display_name}"
           else
             parent.dirname.to_s
           end

data/lib/xcake/xcodeproj_ext/PBXNativeTarget.rb

@@ -4,7 +4,6 @@ module Xcodeproj
   class Project
     module Object
       class PBXNativeTarget
-        #TODO: BDD
         def build_phase_by_class(phase_class)
           find_or_create_build_phase_by_class(phase_class)
         end

data/lib/xcake.rb

@@ -1,10 +1,16 @@
 require 'xcake/core_ext/array'
 require 'xcake/core_ext/object'
 require 'xcake/core_ext/string'
+
+require 'xcake/xcode/project'
+require 'xcake/xcode/scheme'
+require 'xcake/xcode/scheme_list'
+
 require 'xcake/xcodeproj_ext/PBXGroup'
 require 'xcake/xcodeproj_ext/PBXNativeTarget'
-require 'xcake/modern_xcodeproj.rb'
 
+require 'xcake/constants'
+require 'xcake/modern_xcodeproj'
 require 'xcake/version'
 require 'xcake/event_hooks'
 require 'xcake/ui'
@@ -30,15 +36,14 @@ require 'xcake/project'
 require 'xcake/project/sugar'
 require 'xcake/project/hooks'
 require 'xcake/path_classifier'
-require 'xcake/shell_script_build_phase'
 
 require 'xcake/target'
 require 'xcake/target/sugar'
 require 'xcake/target/configurable'
 
-require 'xcake/xcode/project'
-require 'xcake/xcode/scheme'
-require 'xcake/xcode/scheme_list'
+require 'xcake/build_phase'
+require 'xcake/build_phase/headers_build_phase'
+require 'xcake/build_phase/shell_script_build_phase'
 
 module Xcake
 end

data/rubocop.yml

@@ -35,10 +35,6 @@ AllCops:
   Exclude:
     - 'lib/assets/custom_action_template.rb'
 
-##################
-# TODO
-##################
-
 # Offense count: 20
 Metrics/AbcSize:
   Max: 63

data/xcake.gemspec

@@ -21,6 +21,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
+  spec.add_dependency 'claide', '< 2.0', '>= 0.9.1'
+  spec.add_dependency 'cork'
+  spec.add_dependency 'hooks', '~> 0.4.1'
+  spec.add_dependency 'xcodeproj', '< 2.0.0', '>= 0.21'
+
+  # Lock `activesupport` (transitive dependency via `xcodeproj`) to keep supporting system ruby
+  spec.add_dependency 'activesupport', '< 5'
+
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.4.0'
@@ -28,11 +36,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-git', '~> 0.1.1'
   spec.add_development_dependency 'yard', '~> 0.8'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_dependency 'claide', '< 2.0', '>= 0.9.1'
-  spec.add_dependency 'hooks', '~> 0.4.1'
-  spec.add_dependency 'xcodeproj', '< 2.0.0', '>= 0.20'
-  spec.add_dependency 'cork'
-
-  # Lock `activesupport` (transitive depedency via `xcodeproj`) to keep supporting system ruby
-  spec.add_dependency 'activesupport', '< 5'
 end