Whitelist Pods by build configuration

lib/cocoapods-core/podfile/dsl.rb

@@ -89,6 +89,26 @@ module DSL
       #
       # ------
       #
+      # ### Build configurations
+      #
+      # *IMPORTANT*: the following syntax is tentative and might change without
+      # notice in future. This feature is released in this state due to
+      # the strong demand for it. You can use it but you might need to change
+      # your Podfile to use future versions of CocoaPods. Anyway a clear and
+      # simple upgrade path will be provided.
+      #
+      # By default dependencies are installed on all the build configurations
+      # of the target. For debug purposes or for other reasons, they can be
+      # enabled only on a given list of build configuration names.
+      #
+      #     pod 'PonyDebugger', :configurations => ['Release', 'App Store']
+      #
+      # Alternatively you can white-list only a single build configuration.
+      #
+      #     pod 'PonyDebugger', :configuration => ['Release']
+      #
+      # ------
+      #
       # Dependencies can be obtained also from external sources.
       #
       #

lib/cocoapods-core/podfile/target_definition.rb

@@ -316,6 +316,60 @@ def inhibit_warnings_for_pod(pod_name)
 
       #--------------------------------------#
 
+      # Whether a specific pod should be linked to the target when building for
+      # a specific configuration. If a pod has not been explicitly whitelisted
+      # for any configuration, it is implicitly whitelisted.
+      #
+      # @param  [String] pod_name
+      #         The pod that we're querying about inclusion for in the given
+      #         configuration.
+      #
+      # @param  [String] configuration_name
+      #         The configuration that we're querying about inclusion of the
+      #         pod in.
+      #
+      # @return [Bool] flag
+      #         Whether the pod should be linked with the target
+      #
+      def pod_whitelisted_for_configuration?(pod_name, configuration_name)
+        found = false
+        configuration_pod_whitelist.each do |configuration, pods|
+          if pods.include?(pod_name)
+            found = true
+            return true if configuration == configuration_name
+          end
+        end
+        !found
+      end
+
+      # Whitelists a pod for a specific configuration. If a pod is whitelisted
+      # for any configuration, it will only be linked with the target in the
+      # configuration(s) specified. If it is not whitelisted for any configuration,
+      # it is implicitly included in all configurations.
+      #
+      # @param  [String] pod_name
+      #         The pod that should be included in the given configuration.
+      #
+      # @param  [String, Symbol] configuration_name
+      #         The configuration that the pod should be included in
+      #
+      # @return [void]
+      #
+      def whitelist_pod_for_configuration(pod_name, configuration_name)
+        configuration_name = configuration_name.to_s
+        configuration_pod_whitelist[configuration_name] ||= []
+        configuration_pod_whitelist[configuration_name] << pod_name
+      end
+
+      # @return [Array<String>] unique list of all configurations for which
+      #         pods have been whitelisted.
+      #
+      def all_whitelisted_configurations
+        configuration_pod_whitelist.keys.uniq
+      end
+
+      #--------------------------------------#
+
       # @return [Platform] the platform of the target definition.
       #
       # @note   If no deployment target has been specified a default value is
@@ -384,6 +438,7 @@ def set_platform(name, target = nil)
       #
       def store_pod(name, *requirements)
         parse_inhibit_warnings(name, requirements)
+        parse_configuration_whitelist(name, requirements)
 
         if requirements && !requirements.empty?
           pod = { name => requirements }
@@ -444,6 +499,7 @@ def store_podspec(options = nil)
         build_configurations
         dependencies
         children
+        configuration_pod_whitelist
       ).freeze
 
       # @return [Hash] The hash representation of the target definition.
@@ -537,6 +593,16 @@ def inhibit_warnings_hash
         get_hash_value('inhibit_warnings', {})
       end
 
+      # Returns the configuration_pod_whitelist hash
+      #
+      # @return [Hash<String, Array>] Hash with configuration name as key,
+      #         array of pod names to be linked in builds with that configuration
+      #         as value.
+      #
+      def configuration_pod_whitelist
+        get_hash_value('configuration_pod_whitelist', {})
+      end
+
       # @return [Array<Dependency>] The dependencies specified by the user for
       #         this target definition.
       #
@@ -619,6 +685,32 @@ def parse_inhibit_warnings(name, requirements)
         requirements.pop if options.empty?
       end
 
+      # Removes :configurations or :configuration from the requirements list,
+      # and adds the pod's name into the internal hash for which pods should be
+      # linked in which configuration only.
+      #
+      # @param [String] pod name
+      #
+      # @param [Array] requirements
+      #        If :configurations is the only key in the hash, the hash
+      #        should be destroyed because it confuses Gem::Dependency.
+      #
+      # @return [void]
+      #
+      def parse_configuration_whitelist(name, requirements)
+        options = requirements.last
+        return requirements unless options.is_a?(Hash)
+
+        configurations = options.delete(:configurations)
+        configurations ||= options.delete(:configuration)
+        if configurations
+          Array(configurations).each do |configuration|
+            whitelist_pod_for_configuration(name, configuration)
+          end
+        end
+        requirements.pop if options.empty?
+      end
+
       #-----------------------------------------------------------------------#
     end
   end

rubocop-todo.yml

@@ -8,7 +8,7 @@
 # Offense count: 9
 # Configuration parameters: CountComments.
 ClassLength:
-  Max: 267
+  Max: 302
 
 # Offense count: 10
 CyclomaticComplexity:

spec/podfile/dsl_spec.rb

@@ -14,6 +14,37 @@ module Pod
         podfile.dependencies.find { |d| d.root_name == 'SSZipArchive' }.should   == Dependency.new('SSZipArchive', '>= 0.1')
       end
 
+      it 'white-list dependencies on all build configuration by default' do
+        podfile = Podfile.new do
+          pod 'PonyDebugger'
+        end
+
+        target = podfile.target_definitions['Pods']
+        target.pod_whitelisted_for_configuration?('PonyDebugger', 'Release').should.be.true
+        target.pod_whitelisted_for_configuration?('PonyDebugger', 'Debug').should.be.true
+      end
+
+      it 'allows to white-list a dependency on multiple build configuration' do
+        podfile = Podfile.new do
+          pod 'PonyDebugger', :configurations => ['Release', 'App Store']
+        end
+
+        target = podfile.target_definitions['Pods']
+        target.pod_whitelisted_for_configuration?('PonyDebugger', 'Release').should.be.true
+        target.pod_whitelisted_for_configuration?('PonyDebugger', 'App Store').should.be.true
+        target.pod_whitelisted_for_configuration?('PonyDebugger', 'Debug').should.be.false
+      end
+
+      it 'allows to white-list a dependency on a build configuration' do
+        podfile = Podfile.new do
+          pod 'PonyDebugger', :configuration => 'Release'
+        end
+
+        target = podfile.target_definitions['Pods']
+        target.pod_whitelisted_for_configuration?('PonyDebugger', 'Release').should.be.true
+        target.pod_whitelisted_for_configuration?('PonyDebugger', 'Debug').should.be.false
+      end
+
       it 'raises if no name is specified for a Pod' do
         lambda do
           Podfile.new do
@@ -92,7 +123,7 @@ module Pod
         end
       end
 
-      it 'allows to specify the user xcode project for a Target definition' do
+      it 'allows to specify the user Xcode project for a Target definition' do
         podfile = Podfile.new { xcodeproj 'App.xcodeproj' }
         podfile.target_definitions['Pods'].user_project_path.should == 'App.xcodeproj'
       end

spec/podfile/target_definition_spec.rb

@@ -230,6 +230,43 @@ module Pod
 
       #--------------------------------------#
 
+      it 'whitelists pods by default' do
+        @root.store_pod('ObjectiveSugar')
+        @root.should.pod_whitelisted_for_configuration?('ObjectiveSugar', 'Release')
+      end
+
+      it 'does not enable pods for un-whitelisted configurations if it is whitelisted for another' do
+        @root.store_pod('ObjectiveSugar')
+        @root.whitelist_pod_for_configuration('ObjectiveSugar', 'Release')
+        @root.should.not.pod_whitelisted_for_configuration?('ObjectiveSugar', 'Debug')
+      end
+
+      it 'enables pods for configurations they are whitelisted for' do
+        @root.store_pod('ObjectiveSugar', :configuration => 'Release')
+        @root.should.pod_whitelisted_for_configuration?('ObjectiveSugar', 'Release')
+        @root.should.not.pod_whitelisted_for_configuration?('ObjectiveSugar', 'Debug')
+        @root.store_pod('AFNetworking', :configurations => ['Debug'])
+        @root.should.pod_whitelisted_for_configuration?('AFNetworking', 'Debug')
+        @root.should.not.pod_whitelisted_for_configuration?('AFNetworking', 'Release')
+      end
+
+      it 'coerces configuration names to strings' do
+        @root.store_pod('ObjectiveSugar', :configuration => :Release)
+        @root.should.pod_whitelisted_for_configuration?('ObjectiveSugar', 'Release')
+        @root.should.not.pod_whitelisted_for_configuration?('ObjectiveSugar', 'Debug')
+      end
+
+      it 'returns a unique list of all whitelisted configurations' do
+        @root.all_whitelisted_configurations.should == []
+        @root.whitelist_pod_for_configuration('ObjectiveSugar', 'Release')
+        @root.whitelist_pod_for_configuration('AFNetworking', 'Release')
+        @root.all_whitelisted_configurations.should == ['Release']
+        @root.whitelist_pod_for_configuration('Objective-Record', 'Debug')
+        @root.all_whitelisted_configurations.should == %w(Release Debug)
+      end
+
+      #--------------------------------------#
+
       it 'returns its platform' do
         @root.platform.should == Pod::Platform.new(:ios, '6.0')
       end