Introduce test_specification DSL

Author: kylef

CHANGELOG.md

@@ -4,7 +4,10 @@
 
 ##### Enhancements
 
-* None.  
+* Introduce `test_specification` DSL  
+  [Dimitris Koutsogiorgas](https://github.com/dnkoutso)
+  [Kyle Fuller](https://github.com/kylef)
+  [#369](https://github.com/CocoaPods/Core/pull/369)
 
 ##### Bug Fixes
 

lib/cocoapods-core/specification.rb

@@ -34,13 +34,18 @@ class Specification
     # @param  [String] name
     #         the name of the specification.
     #
-    def initialize(parent = nil, name = nil)
+    # @param [Bool] test_specification
+    #        Whether the specification is a test specification
+    #
+    def initialize(parent = nil, name = nil, test_specification = false)
       @attributes_hash = {}
       @subspecs = []
       @consumers = {}
       @parent = parent
       @hash_value = nil
+      @test_specification = test_specification
       attributes_hash['name'] = name
+      attributes_hash['test_type'] = :unit if test_specification
 
       yield self if block_given?
     end
@@ -203,7 +208,26 @@ def subspec?
 
     # @!group Dependencies & Subspecs
 
-    # @return [Array<Specifications>] the recursive list of all the subspecs of
+    # @return [Bool] if the specification is a test specification
+    #
+    def test_specification?
+      @test_specification
+    end
+
+    # @return [Symbol] the test type supported if this is a test specification
+    #
+    def test_type
+      attributes_hash['test_type']
+    end
+
+    # @return [Array<Specification>] the list of all the test subspecs of
+    #         a specification.
+    #
+    def test_specs
+      subspecs.select(&:test_specification?)
+    end
+
+    # @return [Array<Specification>] the recursive list of all the subspecs of
     #         a specification.
     #
     def recursive_subspecs
@@ -241,7 +265,7 @@ def subspec_by_name(relative_name, raise_if_missing = true)
       else
         remainder = relative_name[base_name.size + 1..-1]
         subspec_name = remainder.split('/').shift
-        subspec = subspecs.find { |s| s.base_name == subspec_name }
+        subspec = subspecs.find { |s| s.base_name == subspec_name && !s.test_specification? }
         unless subspec
           if raise_if_missing
             raise Informative, 'Unable to find a specification named ' \
@@ -274,7 +298,7 @@ def default_subspecs
     #
     def subspec_dependencies(platform = nil)
       specs = if default_subspecs.empty?
-                subspecs.compact
+                subspecs.compact.reject(&:test_specification?)
               else
                 default_subspecs.map do |subspec_name|
                   root.subspec_by_name("#{name}/#{subspec_name}")
@@ -288,9 +312,8 @@ def subspec_dependencies(platform = nil)
 
     # Returns the dependencies on other Pods or subspecs of other Pods.
     #
-    # @param  [Bool] all_platforms
-    #         whether the dependencies should be returned for all platforms
-    #         instead of the active one.
+    # @param  [Platform] platform
+    #         return only dependencies supported on the given platform.
     #
     # @note   External dependencies are inherited by subspecs
     #

lib/cocoapods-core/specification/consumer.rb

@@ -182,6 +182,11 @@ def user_target_xcconfig
       #
       spec_attr_accessor :preserve_paths
 
+      # @return [Symbol] the directory from where to preserve the headers
+      #         namespacing.
+      #
+      spec_attr_accessor :test_type
+
       #-----------------------------------------------------------------------#
 
       # @return [Array<Dependency>] the dependencies on other Pods.

lib/cocoapods-core/specification/dsl.rb

@@ -1324,6 +1324,48 @@ def subspec(name, &block)
         subspec
       end
 
+      # The names of the test types currently supported.
+      #
+      TEST_TYPES = [:unit].freeze
+
+      # The test type this specification supports. This only applies to test specifications.
+      #
+      # ---
+      #
+      # @example
+      #
+      #   test_spec.test_type = :unit
+      #
+      # @param  [Symbol] type
+      #         The test type to use.
+      attribute :test_type,
+                :container => Array,
+                :types => [Symbol],
+                :keys => TEST_TYPES,
+                :multi_platform => false
+
+      # Represents a test specification for the library. Here you can place all
+      # your tests for your podspec along with the test dependencies.
+      #
+      # ---
+      #
+      # @example
+      #
+      #   Pod::Spec.new do |spec|
+      #     spec.name = 'NSAttributedString+CCLFormat'
+      #
+      #     spec.test_spec do |test_spec|
+      #       test_spec.source_files = 'NSAttributedString+CCLFormatTests.m'
+      #       test_spec.dependency 'Expecta'
+      #     end
+      #   end
+      #
+      def test_spec(name = 'Tests', &block)
+        subspec = Specification.new(self, name, true, &block)
+        @subspecs << subspec
+        subspec
+      end
+
       #------------------#
 
       # @!method default_subspecs=(subspec_array)

lib/cocoapods-core/specification/linter.rb

@@ -128,7 +128,7 @@ def run_root_validation_hooks
         run_validation_hooks(attributes, spec)
       end
 
-      # Run validations for multi-platform attributes activating .
+      # Run validations for multi-platform attributes activating.
       #
       # @return [void]
       #

lib/cocoapods-core/specification/linter/analyzer.rb

@@ -42,7 +42,8 @@ def analyze
         def check_attributes
           attributes_keys = Pod::Specification::DSL.attributes.keys.map(&:to_s)
           platform_keys = Specification::DSL::PLATFORMS.map(&:to_s)
-          valid_keys = attributes_keys + platform_keys
+          test_keys = Specification::DSL::TEST_TYPES.map(&:to_s)
+          valid_keys = attributes_keys + platform_keys + test_keys
           attributes_hash = consumer.spec.attributes_hash
           keys = attributes_hash.keys
           Specification::DSL::PLATFORMS.each do |platform|

spec/specification/dsl_spec.rb

@@ -368,6 +368,27 @@ module Pod
 
     #-----------------------------------------------------------------------------#
 
+    describe 'Test specs' do
+      before do
+        @spec = Spec.new do |spec|
+          spec.name = 'Spec'
+          spec.test_spec do |test_spec|
+            test_spec.test_type = :unit
+          end
+        end
+      end
+
+      it 'allows you to specify a test spec' do
+        test_spec = @spec.subspecs.first
+        test_spec.class.should == Specification
+        test_spec.name.should == 'Spec/Tests'
+        test_spec.test_specification?.should == true
+        test_spec.test_type.should == :unit
+      end
+    end
+
+    #-----------------------------------------------------------------------------#
+
     describe 'Multi-Platform' do
       before do
         @spec = Spec.new do |s|

spec/specification/linter/analyzer_spec.rb

@@ -90,6 +90,15 @@ module Pod
           results.first.attribute_name.should.include?('keys')
         end
 
+        it 'fails a spec with unknown sub-keys for test' do
+          @spec.test_type = :unknown
+          results = @analyzer.analyze
+          results.count.should.be.equal(1)
+          expected = 'Unrecognized `unknown` key'
+          results.first.message.should.include?(expected)
+          results.first.attribute_name.should.include?('keys')
+        end
+
         it 'validates a spec with valid minor sub-keys' do
           @spec.source = { :git => 'example.com', :branch => 'master' }
           results = @analyzer.analyze

spec/specification_spec.rb

@@ -217,23 +217,30 @@ module Pod
           s.name = 'Pod'
           s.subspec 'Subspec' do |_sp|
           end
+          s.test_spec do |_tsp|
+          end
         end
         @subspec = @spec.subspecs.first
+        @test_subspec = @spec.test_specs.first
       end
 
       it 'returns the root spec' do
         @spec.root.should == @spec
         @subspec.root.should == @spec
+        @test_subspec.root.should == @spec
       end
 
       it 'returns whether it is a root spec' do
         @spec.root?.should.be.true
         @subspec.root?.should.be.false
+        @test_subspec.root?.should.be.false
       end
 
       it 'returns whether it is a subspec' do
         @spec.subspec?.should.be.false
         @subspec.subspec?.should.be.true
+        @test_subspec.subspec?.should.be.true
+        @test_subspec.test_specification?.should.be.true
       end
     end
 
@@ -273,6 +280,17 @@ module Pod
         @spec.subspec_by_name('Pod/Subspec/Subsubspec').should == @subsubspec
       end
 
+      it "doesn't return the test subspec given the Tests name" do
+        @spec = Spec.new do |s|
+          s.name = 'Pod'
+          s.version = '1.0'
+          s.dependency 'AFNetworking'
+          s.osx.dependency 'MagicalRecord'
+          s.test_spec {}
+        end
+        @spec.subspec_by_name('Pod/Tests', false).should. nil?
+      end
+
       it 'returns a subspec given the relative name' do
         @subspec.subspec_by_name('Subspec/Subsubspec').should == @subsubspec
       end
@@ -327,12 +345,29 @@ module Pod
         ]
       end
 
+      it 'excludes the test subspec from the subspec dependencies' do
+        @spec.test_spec {}
+        @spec.subspec_dependencies.sort.should == [
+          Dependency.new('Pod/Subspec', '1.0'),
+          Dependency.new('Pod/SubspecOSX', '1.0'),
+          Dependency.new('Pod/SubspeciOS', '1.0')]
+      end
+
       it 'returns all the dependencies' do
         @spec.dependencies.sort.should == [
           Dependency.new('AFNetworking'),
           Dependency.new('MagicalRecord')]
       end
 
+      it 'returns the test spec dependencies' do
+        test_spec = @spec.test_spec { |s| s.dependency 'OCMock' }
+        test_spec.dependencies.sort.should == [
+          Dependency.new('AFNetworking'),
+          Dependency.new('MagicalRecord'),
+          Dependency.new('OCMock'),
+        ]
+      end
+
       it 'returns the dependencies given the platform' do
         @spec.dependencies(:ios).sort.should == [Dependency.new('AFNetworking')]
       end