Fix gRPC.podspec to pass pod spec lint

- Relax protobuf requirement to alpha version - Suppress warnings for GRPCClient - Fix headers search path - Document hacks.
Infixz · Jun 4, 2015 · 461b094 · 461b094
1 parent 669c139
commit 461b094
Showing 1 changed file with 22 additions and 16 deletions.
diff --git a/gRPC.podspec b/gRPC.podspec
@@ -13,23 +13,27 @@ Pod::Spec.new do |s|
   s.osx.deployment_target = '10.8'
   s.requires_arc = true
 
+  # Reactive Extensions library for iOS.
   s.subspec 'RxLibrary' do |rs|
-    rs.summary  = 'Reactive Extensions library for iOS.'
-
     rs.source_files = 'src/objective-c/RxLibrary/*.{h,m}',
                       'src/objective-c/RxLibrary/transformations/*.{h,m}',
                       'src/objective-c/RxLibrary/private/*.{h,m}'
     rs.private_header_files = 'src/objective-c/RxLibrary/private/*.h'
   end
 
+  # Core cross-platform gRPC library, written in C.
   s.subspec 'C-Core' do |cs|
-    cs.summary  = 'Core cross-platform gRPC library, written in C.'
-
     cs.source_files = 'src/core/**/*.{h,c}', 'include/grpc/*.h', 'include/grpc/**/*.h'
     cs.private_header_files = 'src/core/**/*.h'
     cs.header_mappings_dir = '.'
-    cs.xcconfig = { 'HEADER_SEARCH_PATHS' => '"$(PODS_ROOT)/Headers/Build/gRPC" '
-                                             '"$(PODS_ROOT)/Headers/Build/gRPC/include"' }
+    # The core library includes its headers as either "src/core/..." or "grpc/...", meaning we have
+    # to tell XCode to look for headers under the "include" subdirectory too.
+    #
+    # TODO(jcanizales): Instead of doing this, during installation move everything under
+    # "include/grpc" one directory up. The directory names under PODS_ROOT are implementation
+    # details of Cocoapods, and have changed in the past, breaking this podspec.
+    cs.xcconfig = { 'HEADER_SEARCH_PATHS' => '"$(PODS_ROOT)/Headers/Private/gRPC" ' +
+                                             '"$(PODS_ROOT)/Headers/Private/gRPC/include"' }
     cs.compiler_flags = '-GCC_WARN_INHIBIT_ALL_WARNINGS', '-w'
 
     cs.requires_arc = false
@@ -41,49 +45,51 @@ Pod::Spec.new do |s|
   # It renames time.h and string.h to grpc_time.h and grpc_string.h.
   # It needs to be here (top-level) instead of in the C-Core subspec because Cocoapods doesn't run
   # prepare_command's of subspecs.
+  #
+  # TODO(jcanizales): Try out Todd Reed's solution at Issue #1437.
   s.prepare_command = <<-CMD
     DIR_TIME="grpc/support"
     BAD_TIME="$DIR_TIME/time.h"
     GOOD_TIME="$DIR_TIME/grpc_time.h"
+    grep -rl "$BAD_TIME" include/grpc src/core | xargs sed -i '' -e s@$BAD_TIME@$GOOD_TIME@g
     if [ -f "include/$BAD_TIME" ];
     then
-      grep -rl "$BAD_TIME" include/grpc src/core | xargs sed -i '' -e s@$BAD_TIME@$GOOD_TIME@g
-      mv "include/$BAD_TIME" "include/$GOOD_TIME"
+      mv -f "include/$BAD_TIME" "include/$GOOD_TIME"
     fi
 
     DIR_STRING="src/core/support"
     BAD_STRING="$DIR_STRING/string.h"
     GOOD_STRING="$DIR_STRING/grpc_string.h"
+    grep -rl "$BAD_STRING" include/grpc src/core | xargs sed -i '' -e s@$BAD_STRING@$GOOD_STRING@g
     if [ -f "$BAD_STRING" ];
     then
-      grep -rl "$BAD_STRING" include/grpc src/core | xargs sed -i '' -e s@$BAD_STRING@$GOOD_STRING@g
-      mv "$BAD_STRING" "$GOOD_STRING"
+      mv -f "$BAD_STRING" "$GOOD_STRING"
     fi
   CMD
 
+  # Objective-C wrapper around the core gRPC library.
   s.subspec 'GRPCClient' do |gs|
-    gs.summary = 'Objective-C wrapper around the core gRPC library.'
-
     gs.source_files = 'src/objective-c/GRPCClient/*.{h,m}',
                       'src/objective-c/GRPCClient/private/*.{h,m}'
     gs.private_header_files = 'src/objective-c/GRPCClient/private/*.h'
+    gs.compiler_flags = '-GCC_WARN_INHIBIT_ALL_WARNINGS', '-w'
 
     gs.dependency 'gRPC/C-Core'
-    # Is this needed in all dependents?
+    # TODO(jcanizales): Remove this when the prepare_command moves everything under "include/grpc"
+    # one directory up.
     gs.xcconfig = { 'HEADER_SEARCH_PATHS' => '"$(PODS_ROOT)/Headers/Public/gRPC/include"' }
     gs.dependency 'gRPC/RxLibrary'
 
     # Certificates, to be able to establish TLS connections:
     gs.resource_bundles = { 'gRPC' => ['etc/roots.pem'] }
   end
 
+  # RPC library for ProtocolBuffers, based on gRPC
   s.subspec 'ProtoRPC' do |ps|
-    ps.summary  = 'RPC library for ProtocolBuffers, based on gRPC'
-
     ps.source_files = 'src/objective-c/ProtoRPC/*.{h,m}'
 
     ps.dependency 'gRPC/GRPCClient'
     ps.dependency 'gRPC/RxLibrary'
-    ps.dependency 'Protobuf', '~> 3.0'
+    ps.dependency 'Protobuf', '~> 3.0.0-alpha-3'
   end
 end