cocoapods 1.2.1 → 1.3.0.beta.1

data/lib/cocoapods/installer/xcode/target_validator.rb

@@ -0,0 +1,126 @@
+module Pod
+  class Installer
+    class Xcode
+      # The {Xcode::TargetValidator} ensures that the pod and aggregate target
+      # configuration is valid for installation.
+      #
+      class TargetValidator
+        # @return [Array<AggregateTarget>] The aggregate targets that should be
+        #                                  validated.
+        #
+        attr_reader :aggregate_targets
+
+        # @return [Array<PodTarget>] The pod targets that should be validated.
+        #
+        attr_reader :pod_targets
+
+        # Create a new TargetValidator with aggregate and pod targets to
+        # validate.
+        #
+        # @param [Array<AggregateTarget>] aggregate_targets
+        #                                 The aggregate targets to validate.
+        #
+        # @param [Array<PodTarget>] pod_targets
+        #                           The pod targets to validate.
+        #
+        def initialize(aggregate_targets, pod_targets)
+          @aggregate_targets = aggregate_targets
+          @pod_targets = pod_targets
+        end
+
+        # Perform the validation steps for the provided aggregate and pod
+        # targets.
+        #
+        def validate!
+          verify_no_duplicate_framework_and_library_names
+          verify_no_static_framework_transitive_dependencies
+          verify_no_pods_used_with_multiple_swift_versions
+          verify_framework_usage
+        end
+
+        private
+
+        def verify_no_duplicate_framework_and_library_names
+          aggregate_targets.each do |aggregate_target|
+            aggregate_target.user_build_configurations.keys.each do |config|
+              pod_targets = aggregate_target.pod_targets_for_build_configuration(config)
+              file_accessors = pod_targets.flat_map(&:file_accessors)
+
+              frameworks = file_accessors.flat_map(&:vendored_frameworks).uniq.map(&:basename)
+              frameworks += pod_targets.select { |pt| pt.should_build? && pt.requires_frameworks? }.map(&:product_module_name)
+              verify_no_duplicate_names(frameworks, aggregate_target.label, 'frameworks')
+
+              libraries = file_accessors.flat_map(&:vendored_libraries).uniq.map(&:basename)
+              libraries += pod_targets.select { |pt| pt.should_build? && !pt.requires_frameworks? }.map(&:product_name)
+              verify_no_duplicate_names(libraries, aggregate_target.label, 'libraries')
+            end
+          end
+        end
+
+        def verify_no_duplicate_names(names, label, type)
+          duplicates = names.map { |n| n.to_s.downcase }.group_by { |f| f }.select { |_, v| v.size > 1 }.keys
+
+          unless duplicates.empty?
+            raise Informative, "The '#{label}' target has " \
+              "#{type} with conflicting names: #{duplicates.to_sentence}."
+          end
+        end
+
+        def verify_no_static_framework_transitive_dependencies
+          aggregate_targets.each do |aggregate_target|
+            next unless aggregate_target.requires_frameworks?
+
+            aggregate_target.user_build_configurations.keys.each do |config|
+              pod_targets = aggregate_target.pod_targets_for_build_configuration(config)
+
+              dependencies = pod_targets.select(&:should_build?).flat_map(&:dependencies)
+              dependended_upon_targets = pod_targets.select { |t| dependencies.include?(t.pod_name) && !t.should_build? }
+
+              static_libs = dependended_upon_targets.flat_map(&:file_accessors).flat_map(&:vendored_static_artifacts)
+              unless static_libs.empty?
+                raise Informative, "The '#{aggregate_target.label}' target has " \
+                  "transitive dependencies that include static binaries: (#{static_libs.to_sentence})"
+              end
+            end
+          end
+        end
+
+        def verify_no_pods_used_with_multiple_swift_versions
+          error_message_for_target = lambda do |target|
+            "#{target.name} (Swift #{target.swift_version})"
+          end
+          swift_pod_targets = pod_targets.select(&:uses_swift?)
+          error_messages = swift_pod_targets.map do |pod_target|
+            swift_target_definitions = pod_target.target_definitions.reject { |target| target.swift_version.blank? }
+            next if swift_target_definitions.empty? || swift_target_definitions.uniq(&:swift_version).count == 1
+            target_errors = swift_target_definitions.map(&error_message_for_target).join(', ')
+            "- #{pod_target.name} required by #{target_errors}"
+          end.compact
+
+          unless error_messages.empty?
+            raise Informative, 'The following pods are integrated into targets ' \
+            "that do not have the same Swift version:\n\n#{error_messages.join("\n")}"
+          end
+        end
+
+        def verify_framework_usage
+          aggregate_targets.each do |aggregate_target|
+            next if aggregate_target.requires_frameworks?
+
+            aggregate_target.user_build_configurations.keys.each do |config|
+              pod_targets = aggregate_target.pod_targets_for_build_configuration(config)
+
+              swift_pods = pod_targets.select(&:uses_swift?)
+              unless swift_pods.empty?
+                raise Informative, 'Pods written in Swift can only be integrated as frameworks; ' \
+                  'add `use_frameworks!` to your Podfile or target to opt into using it. ' \
+                  "The Swift #{swift_pods.size == 1 ? 'Pod being used is' : 'Pods being used are'}: " +
+                  swift_pods.map(&:name).to_sentence
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/project.rb

@@ -254,6 +254,11 @@ module Pod
         end
       end
       settings['GCC_PREPROCESSOR_DEFINITIONS'] = definitions
+
+      if type == :debug
+        settings['SWIFT_ACTIVE_COMPILATION_CONDITIONS'] = 'DEBUG'
+      end
+
       build_configuration
     end
 

data/lib/cocoapods/resolver.rb

@@ -305,7 +305,7 @@ module Pod
       find_cached_set(dependency).
         all_specifications(installation_options.warn_for_multiple_pod_sources).
         select { |s| requirement.satisfied_by? s.version }.
-        map { |s| s.subspec_by_name(dependency.name, false) }.
+        map { |s| s.subspec_by_name(dependency.name, false, true) }.
         compact.
         reverse
     end

data/lib/cocoapods/resolver/lazy_specification.rb

@@ -18,11 +18,11 @@ module Pod
           specification.respond_to?(method, include_all)
         end
 
-        def subspec_by_name(name = nil, raise_if_missing = true)
+        def subspec_by_name(name = nil, raise_if_missing = true, include_test_specifications = false)
           if !name || name == self.name
             self
           else
-            specification.subspec_by_name(name, raise_if_missing)
+            specification.subspec_by_name(name, raise_if_missing, include_test_specifications)
           end
         end
 

data/lib/cocoapods/sandbox.rb

@@ -386,5 +386,28 @@ module Pod
     end
 
     #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Pods Helpers
+
+    # Creates the file accessors for the given Pod Targets.
+    #
+    # @param [Array<PodTarget>] pod_targets
+    #                           The Pod Targets to create file accessors for.
+    #
+    def create_file_accessors(pod_targets)
+      pod_targets.each do |pod_target|
+        pod_root = pod_dir(pod_target.root_spec.name)
+        path_list = PathList.new(pod_root)
+        file_accessors = pod_target.specs.map do |spec|
+          FileAccessor.new(path_list, spec.consumer(pod_target.platform))
+        end
+        pod_target.file_accessors ||= []
+        pod_target.file_accessors.concat(file_accessors)
+      end
+    end
+
+    #-------------------------------------------------------------------------#
   end
 end

data/lib/cocoapods/target/pod_target.rb

@@ -28,6 +28,16 @@ module Pod
     #
     attr_accessor :dependent_targets
 
+    # @return [Array<PodTarget>] the targets that this target has a test dependency
+    #         upon.
+    #
+    attr_accessor :test_dependent_targets
+
+    # return [Array<PBXNativeTarget>] the test target generated in the Pods project for
+    #         this library or `nil` if there is no test target created.
+    #
+    attr_accessor :test_native_targets
+
     # @param [Array<Specification>] specs @see #specs
     # @param [Array<TargetDefinition>] target_definitions @see #target_definitions
     # @param [Sandbox] sandbox @see #sandbox
@@ -46,7 +56,9 @@ module Pod
       @build_headers  = Sandbox::HeadersStore.new(sandbox, 'Private')
       @file_accessors = []
       @resource_bundle_targets = []
+      @test_native_targets = []
       @dependent_targets = []
+      @test_dependent_targets = []
       @build_config_cache = {}
     end
 
@@ -133,7 +145,7 @@ module Pod
     #
     attr_accessor :file_accessors
 
-    # @return [Array<PBXTarget>] the resource bundle targets belonging
+    # @return [Array<PBXNativeTarget>] the resource bundle targets belonging
     #         to this target.
     attr_reader :resource_bundle_targets
 
@@ -157,7 +169,7 @@ module Pod
       specs.map { |spec| spec.consumer(platform) }
     end
 
-    # @return [Boolean] Whether the target uses Swift code
+    # @return [Boolean] Whether the target uses Swift code.
     #
     def uses_swift?
       return @uses_swift if defined? @uses_swift
@@ -168,6 +180,52 @@ module Pod
       end
     end
 
+    # @return [Boolean] Whether the target has any tests specifications.
+    #
+    def contains_test_specifications?
+      specs.any?(&:test_specification?)
+    end
+
+    # @return [Array<Symbol>] All of the test supported types within this target.
+    #
+    def supported_test_types
+      specs.select(&:test_specification?).map(&:test_type).uniq
+    end
+
+    # Returns the corresponding native target to use based on the provided specification.
+    # This is used to figure out whether to add a source file into the library native target or any of the
+    # test native targets.
+    #
+    # @param  [Specification] spec
+    #         The specifcation to base from in order to find the native target.
+    #
+    # @return [PBXNativeTarget] the native target to use or `nil` if none is found.
+    #
+    def native_target_for_spec(spec)
+      return native_target unless spec.test_specification?
+      test_native_targets.find do |native_target|
+        native_target.symbol_type == product_type_for_test_type(spec.test_type)
+      end
+    end
+
+    # Returns the corresponding native product type to use given the test type.
+    # This is primarily used when creating the native targets in order to produce the correct test bundle target
+    # based on the type of tests included.
+    #
+    # @param  [Symbol] test_type
+    #         The test type to map to provided by the test specification DSL.
+    #
+    # @return [Symbol] The native product type to use.
+    #
+    def product_type_for_test_type(test_type)
+      case test_type
+      when :unit
+        :unit_test_bundle
+      else
+        raise Informative, "Unknown test type `#{test_type}`."
+      end
+    end
+
     # @return [Specification] The root specification for the target.
     #
     def root_spec
@@ -189,6 +247,15 @@ module Pod
       "#{label}-#{bundle_name}"
     end
 
+    # @param  [Symbol] test_type
+    #         The test type to use for producing the test label.
+    #
+    # @return [String] The derived name of the test target.
+    #
+    def test_target_label(test_type)
+      "#{label}-#{test_type.capitalize}-Tests"
+    end
+
     # @return [Array<String>] The names of the Pods on which this target
     #         depends.
     #
@@ -234,7 +301,7 @@ module Pod
 
       if whitelists.empty?
         @build_config_cache[key] = true
-        return true
+        true
       elsif whitelists.count == 1
         @build_config_cache[key] = whitelists.first
         whitelists.first
@@ -258,7 +325,7 @@ module Pod
 
       if whitelists.empty?
         @inhibit_warnings = false
-        return false
+        false
       elsif whitelists.count == 1
         @inhibit_warnings = whitelists.first
         whitelists.first
@@ -268,7 +335,7 @@ module Pod
           'settings to inhibit warnings. CocoaPods does not currently ' \
           'support different settings and will fall back to your preference ' \
           'set in the root target definition.'
-        return podfile.root_target_definitions.first.inhibits_warnings_for_pod?(root_spec.name)
+        podfile.root_target_definitions.first.inhibits_warnings_for_pod?(root_spec.name)
       end
     end
 

data/lib/cocoapods/validator.rb

@@ -28,8 +28,12 @@ module Pod
     #         the Source URLs to use in creating a {Podfile}.
     #
     def initialize(spec_or_path, source_urls)
-      @source_urls = source_urls.map { |url| config.sources_manager.source_with_name_or_url(url) }.map(&:url)
       @linter = Specification::Linter.new(spec_or_path)
+      @source_urls = if @linter.spec && @linter.spec.dependencies.empty?
+                       []
+                     else
+                       source_urls.map { |url| config.sources_manager.source_with_name_or_url(url) }.map(&:url)
+                     end
     end
 
     #-------------------------------------------------------------------------#
@@ -68,7 +72,7 @@ module Pod
       a_spec = spec
       if spec && @only_subspec
         subspec_name = @only_subspec.start_with?(spec.root.name) ? @only_subspec : "#{spec.root.name}/#{@only_subspec}"
-        a_spec = spec.subspec_by_name(subspec_name)
+        a_spec = spec.subspec_by_name(subspec_name, true, true)
         @subspec_name = a_spec.name
       end
 
@@ -142,15 +146,8 @@ module Pod
         reasons << 'all results apply only to public specs, but you can use ' \
                    '`--private` to ignore them if linting the specification for a private pod'
       end
-      if dot_swift_version.nil?
-        reasons.to_sentence + ".\n[!] The validator for Swift projects uses " \
-          'Swift 3.0 by default, if you are using a different version of ' \
-          'swift you can use a `.swift-version` file to set the version for ' \
-          "your Pod. For example to use Swift 2.3, run: \n" \
-          '    `echo "2.3" > .swift-version`'
-      else
-        reasons.to_sentence
-      end
+
+      reasons.to_sentence
     end
 
     #-------------------------------------------------------------------------#
@@ -189,10 +186,14 @@ module Pod
     #
     attr_accessor :only_subspec
 
-    # @return [Bool] Whether the validator should validate all subspecs
+    # @return [Bool] Whether the validator should validate all subspecs.
     #
     attr_accessor :no_subspecs
 
+    # @return [Bool] Whether the validator should skip building and running tests.
+    #
+    attr_accessor :skip_tests
+
     # @return [Bool] Whether frameworks should be used for the installation.
     #
     attr_accessor :use_frameworks
@@ -245,7 +246,7 @@ module Pod
     # @return [Pathname] the temporary directory used by the linter.
     #
     def validation_dir
-      Pathname(Dir.tmpdir) + 'CocoaPods/Lint'
+      @validation_dir ||= Pathname(Dir.mktmpdir(['CocoaPods-Lint-', "-#{spec.name}"]))
     end
 
     # @return [String] the SWIFT_VERSION to use for validation.
@@ -290,6 +291,10 @@ module Pod
     # Perform analysis for a given spec (or subspec)
     #
     def perform_extensive_analysis(spec)
+      if spec.test_specification?
+        error('spec', "Validating a test spec (`#{spec.name}`) is not supported.")
+        return false
+      end
       validate_homepage(spec)
       validate_screenshots(spec)
       validate_social_media_url(spec)
@@ -304,9 +309,11 @@ module Pod
           download_pod
           check_file_patterns
           install_pod
+          validate_dot_swift_version
           add_app_project_import
           validate_vendored_dynamic_frameworks
           build_pod
+          test_pod unless skip_tests
         ensure
           tear_down_validation_environment
         end
@@ -324,7 +331,7 @@ module Pod
     # Recursively perform the extensive analysis on all subspecs
     #
     def perform_extensive_subspec_analysis(spec)
-      spec.subspecs.send(fail_fast ? :all? : :each) do |subspec|
+      spec.subspecs.reject(&:test_specification?).send(fail_fast ? :all? : :each) do |subspec|
         @subspec_name = subspec.name
         perform_extensive_analysis(subspec)
       end
@@ -378,6 +385,17 @@ module Pod
       validate_url(spec.documentation_url) if spec.documentation_url
     end
 
+    def validate_dot_swift_version
+      if !used_swift_version.nil? && dot_swift_version.nil?
+        warning(:swift_version,
+                'The validator for Swift projects uses ' \
+                'Swift 3.0 by default, if you are using a different version of ' \
+                'swift you can use a `.swift-version` file to set the version for ' \
+                "your Pod. For example to use Swift 2.3, run: \n" \
+                '    `echo "2.3" > .swift-version`')
+      end
+    end
+
     def setup_validation_environment
       validation_dir.rmtree if validation_dir.exist?
       validation_dir.mkpath
@@ -401,10 +419,11 @@ module Pod
     end
 
     def download_pod
-      podfile = podfile_from_spec(consumer.platform_name, deployment_target, use_frameworks)
+      podfile = podfile_from_spec(consumer.platform_name, deployment_target, use_frameworks, consumer.spec.test_specs.map(&:name))
       sandbox = Sandbox.new(config.sandbox_root)
       @installer = Installer.new(sandbox, podfile)
       @installer.use_default_plugins = false
+      @installer.has_dependencies = !spec.dependencies.empty?
       %i(prepare resolve_dependencies download_dependencies).each { |m| @installer.send(m) }
       @file_accessor = @installer.pod_targets.flat_map(&:file_accessors).find { |fa| fa.spec.name == consumer.spec.name }
     end
@@ -480,15 +499,13 @@ module Pod
     # for all available platforms with xcodebuild.
     #
     def install_pod
-      %i(verify_no_duplicate_framework_and_library_names
-         verify_no_static_framework_transitive_dependencies
-         verify_framework_usage generate_pods_project integrate_user_project
+      %i(validate_targets generate_pods_project integrate_user_project
          perform_post_install_actions).each { |m| @installer.send(m) }
 
       deployment_target = spec.subspec_by_name(subspec_name).deployment_target(consumer.platform_name)
       @installer.aggregate_targets.each do |target|
         target.pod_targets.each do |pod_target|
-          next unless native_target = pod_target.native_target
+          next unless (native_target = pod_target.native_target)
           native_target.build_configuration_list.build_configurations.each do |build_configuration|
             (build_configuration.build_settings['OTHER_CFLAGS'] ||= '$(inherited)') << ' -Wincomplete-umbrella'
             build_configuration.build_settings['SWIFT_VERSION'] = swift_version if pod_target.uses_swift?
@@ -529,28 +546,38 @@ module Pod
         UI.warn "Skipping compilation with `xcodebuild' because it can't be found.\n".yellow
       else
         UI.message "\nBuilding with xcodebuild.\n".yellow do
-          output = xcodebuild
+          scheme = if skip_import_validation?
+                     @installer.pod_targets.find { |pt| pt.pod_name == spec.root.name }.label
+                   else
+                     'App'
+                   end
+          output = xcodebuild('build', scheme, 'Release')
           UI.puts output
           parsed_output = parse_xcodebuild_output(output)
-          parsed_output.each do |message|
-            # Checking the error for `InputFile` is to work around an Xcode
-            # issue where linting would fail even though `xcodebuild` actually
-            # succeeds. Xcode.app also doesn't fail when this issue occurs, so
-            # it's safe for us to do the same.
-            #
-            # For more details see https://github.com/CocoaPods/CocoaPods/issues/2394#issuecomment-56658587
-            #
-            if message.include?("'InputFile' should have")
-              next
-            end
+          translate_output_to_linter_messages(parsed_output)
+        end
+      end
+    end
 
-            if message =~ /\S+:\d+:\d+: error:/
-              error('xcodebuild', message)
-            elsif message =~ /\S+:\d+:\d+: warning:/
-              warning('xcodebuild', message)
-            else
-              note('xcodebuild', message)
-            end
+    # Builds and runs all test sources associated with the current specification being validated.
+    #
+    # @note   Xcode warnings are treaded as notes because the spec maintainer
+    #         might not be the author of the library
+    #
+    # @return [void]
+    #
+    def test_pod
+      if !xcodebuild_available?
+        UI.warn "Skipping test validation with `xcodebuild' because it can't be found.\n".yellow
+      else
+        UI.message "\nTesting with xcodebuild.\n".yellow do
+          pod_target = @installer.pod_targets.find { |pt| pt.pod_name == spec.root.name }
+          consumer.spec.test_specs.each do |test_spec|
+            scheme = pod_target.native_target_for_spec(test_spec)
+            output = xcodebuild('test', scheme, 'Debug')
+            UI.puts output
+            parsed_output = parse_xcodebuild_output(output)
+            translate_output_to_linter_messages(parsed_output)
           end
         end
       end
@@ -670,6 +697,29 @@ module Pod
       add_result(:note, *args)
     end
 
+    def translate_output_to_linter_messages(parsed_output)
+      parsed_output.each do |message|
+        # Checking the error for `InputFile` is to work around an Xcode
+        # issue where linting would fail even though `xcodebuild` actually
+        # succeeds. Xcode.app also doesn't fail when this issue occurs, so
+        # it's safe for us to do the same.
+        #
+        # For more details see https://github.com/CocoaPods/CocoaPods/issues/2394#issuecomment-56658587
+        #
+        if message.include?("'InputFile' should have")
+          next
+        end
+
+        if message =~ /\S+:\d+:\d+: error:/
+          error('xcodebuild', message)
+        elsif message =~ /\S+:\d+:\d+: warning:/
+          warning('xcodebuild', message)
+        else
+          note('xcodebuild', message)
+        end
+      end
+    end
+
     def shares_pod_target_xcscheme?(pod_target)
       Pathname.new(@installer.pods_project.path + pod_target.label).exist?
     end
@@ -719,13 +769,16 @@ module Pod
     # @param  [Bool] use_frameworks
     #         whether frameworks should be used for the installation
     #
+    # @param [Array<String>] test_spec_names
+    #         the test spec names to include in the podfile.
+    #
     # @return [Podfile] a podfile that requires the specification on the
     #         current platform.
     #
     # @note   The generated podfile takes into account whether the linter is
     #         in local mode.
     #
-    def podfile_from_spec(platform_name, deployment_target, use_frameworks = true)
+    def podfile_from_spec(platform_name, deployment_target, use_frameworks = true, test_spec_names = [])
       name     = subspec_name || spec.name
       podspec  = file.realpath
       local    = local?
@@ -741,6 +794,13 @@ module Pod
           else
             pod name, :podspec => podspec.to_s
           end
+          test_spec_names.each do |test_spec_name|
+            if local
+              pod test_spec_name, :path => podspec.dirname.to_s
+            else
+              pod test_spec_name, :podspec => podspec.to_s
+            end
+          end
         end
       end
     end
@@ -771,14 +831,9 @@ module Pod
     # @return [String] Executes xcodebuild in the current working directory and
     #         returns its output (both STDOUT and STDERR).
     #
-    def xcodebuild
+    def xcodebuild(action, scheme, configuration)
       require 'fourflusher'
-      scheme = if skip_import_validation?
-                 @installer.pod_targets.find { |pt| pt.pod_name == spec.root.name }.label
-               else
-                 'App'
-      end
-      command = %W(clean build -workspace #{File.join(validation_dir, 'App.xcworkspace')} -scheme #{scheme} -configuration Release)
+      command = %W(clean #{action} -workspace #{File.join(validation_dir, 'App.xcworkspace')} -scheme #{scheme} -configuration #{configuration})
       case consumer.platform_name
       when :osx, :macos
         command += %w(CODE_SIGN_IDENTITY=)