Merge pull request #2917 from CocoaPods/seg-validate-file-patterns

Validate that a specification's `public_header_files` and `private_header_files` file patterns only match header files.

CHANGELOG.md

@@ -27,6 +27,12 @@ To install release candidates run `[sudo] gem install cocoapods --pre`
   [Samuel Giddins](https://github.com/segiddins)
   [#2623](https://github.com/CocoaPods/CocoaPods/issues/2623)
 
+* Validate that a specification's `public_header_files` and
+  `private_header_files` file patterns only match header files.
+  Also, validate that all file patterns, if given, match at least one file.  
+  [Samuel Giddins](https://github.com/segiddins)
+  [#2914](https://github.com/CocoaPods/CocoaPods/issues/2914)
+
 ##### Bug Fixes
 
 * Fix updating a pod that has subspec dependencies.  

lib/cocoapods/sandbox/file_accessor.rb

@@ -113,8 +113,8 @@ module Pod
       # @return [Array<Pathname>] the public headers of the specification.
       #
       def public_headers(include_frameworks = false)
-        public_headers = paths_for_attribute(:public_header_files)
-        private_headers = paths_for_attribute(:private_header_files)
+        public_headers = public_header_files
+        private_headers = private_header_files
         if public_headers.nil? || public_headers.empty?
           header_files = headers
         else
@@ -210,6 +210,26 @@ module Pod
 
       private
 
+      # @!group Private paths
+
+      # @return [Array<Pathname>] The paths of the user-specified public header
+      #         files.
+      #
+      def public_header_files
+        paths_for_attribute(:public_header_files)
+      end
+
+      # @return [Array<Pathname>] The paths of the user-specified public header
+      #         files.
+      #
+      def private_header_files
+        paths_for_attribute(:private_header_files)
+      end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
       # @!group Private helpers
 
       # Returns the list of the paths founds in the file system for the

lib/cocoapods/validator.rb

@@ -350,6 +350,10 @@ module Pod
       end
     end
 
+    FILE_PATTERNS = %i(source_files resources preserve_paths vendored_libraries
+                       vendored_frameworks public_header_files preserve_paths
+                       private_header_files resource_bundles).freeze
+
     # It checks that every file pattern specified in a spec yields
     # at least one file. It requires the pods to be already present
     # in the current working directory under Pods/spec.name.
@@ -357,8 +361,11 @@ module Pod
     # @return [void]
     #
     def check_file_patterns
-      [:source_files, :resources, :preserve_paths, :vendored_libraries, :vendored_frameworks].each do |attr_name|
-        # file_attr = Specification::DSL.attributes.values.find{|attr| attr.name == attr_name }
+      FILE_PATTERNS.each do |attr_name|
+        if respond_to?("_validate_#{attr_name}", true)
+          send("_validate_#{attr_name}")
+        end
+
         if !file_accessor.spec_consumer.send(attr_name).empty? && file_accessor.send(attr_name).empty?
           error('file patterns', "The `#{attr_name}` pattern did not match any file.")
         end
@@ -371,6 +378,25 @@ module Pod
       end
     end
 
+    def _validate_private_header_files
+      _validate_header_files(:private_header_files)
+    end
+
+    def _validate_public_header_files
+      _validate_header_files(:public_header_files)
+    end
+
+    # Ensures that a list of header files only contains header files.
+    #
+    def _validate_header_files(attr_name)
+      non_header_files = file_accessor.send(attr_name).
+        select { |f| !Xcodeproj::Constants::HEADER_FILES_EXTENSIONS.include?(f.extname) }.
+        map { |f| f.relative_path_from file_accessor.root }
+      unless non_header_files.empty?
+        error(attr_name, "The pattern matches non-header files (#{non_header_files.join(', ')}).")
+      end
+    end
+
     #-------------------------------------------------------------------------#
 
     private

spec/unit/validator_spec.rb

@@ -337,14 +337,36 @@ module Pod
         sut.results.count.should == 0
       end
 
-      it 'checks for file patterns' do
-        file = write_podspec(stub_podspec(/.*source_files.*/, '"source_files": "wrong_paht.*",'))
-        sut = Validator.new(file, SourcesManager.master.map(&:url))
-        sut.stubs(:build_pod)
-        sut.stubs(:validate_url)
-        sut.validate
-        sut.results.map(&:to_s).first.should.match /source_files.*did not match/
-        sut.result_type.should == :error
+      describe 'file pattern validation' do
+        it 'checks for file patterns' do
+          file = write_podspec(stub_podspec(/.*source_files.*/, '"source_files": "wrong_paht.*",'))
+          sut = Validator.new(file, SourcesManager.master.map(&:url))
+          sut.stubs(:build_pod)
+          sut.stubs(:validate_url)
+          sut.validate
+          sut.results.map(&:to_s).first.should.match /source_files.*did not match/
+          sut.result_type.should == :error
+        end
+
+        it 'checks private_header_files matches only headers' do
+          file = write_podspec(stub_podspec(/.*source_files.*/, '"source_files": "JSONKit.*", "private_header_files": "JSONKit.m",'))
+          sut = Validator.new(file, SourcesManager.master.map(&:url))
+          sut.stubs(:build_pod)
+          sut.stubs(:validate_url)
+          sut.validate
+          sut.results.map(&:to_s).first.should.match /matches non-header files \(JSONKit\.m\)/
+          sut.result_type.should == :error
+        end
+
+        it 'checks public_header_files matches only headers' do
+          file = write_podspec(stub_podspec(/.*source_files.*/, '"source_files": "JSONKit.*", "public_header_files": "JSONKit.m",'))
+          sut = Validator.new(file, SourcesManager.master.map(&:url))
+          sut.stubs(:build_pod)
+          sut.stubs(:validate_url)
+          sut.validate
+          sut.results.map(&:to_s).first.should.match /matches non-header files \(JSONKit\.m\)/
+          sut.result_type.should == :error
+        end
       end
 
       it 'validates a podspec with dependencies' do