gym 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574af8b98bbf18a7cd50ea0df99abf0a56614635
-  data.tar.gz: d0479a56afa1949ef434976da023a69fb6a56e5b
+  metadata.gz: 397fb653f19ab23011a6adc4e4868b3cf3685a13
+  data.tar.gz: 4f43ac4c7427a7a1ec0189552a1579029c929d50
 SHA512:
-  metadata.gz: 7b14141ac66187610e817a34f1940a68d4ecf531942b625d267b8d6618afd6ea43320c53bba7399919018a15f51f6301afd6e03ed51aa43284d16612ccedb489
-  data.tar.gz: 6b0046422e07785ae133f0b7ea9edeb43ce524d01f769c8aeb1629a258e48ff37321a29336905ce08e5f397a2cb9ad5b8590fe74aca730bc3596eeddd2fe47a7
+  metadata.gz: a54112ec43584b099105130a45079e38328d8ee5c3dcf9e279d9228d3da2bce5dc0af2b176246b93172840303e8965667976f1a9272ded70fdd264525159d274
+  data.tar.gz: a69f4ca6ec8f5409fedaedc6b36e6bcc788132e5f8ae9bc809d40f923d2144c18526724ab4a48ca7e5c5b296d623f71e02f4f8bea6aa331f844dbee4fc2c632c

data/README.md

@@ -82,14 +82,14 @@ gym
 --------------------------|------------------------------------------------------------
 :rocket:            | `gym` builds 30% faster than other build tools like [shenzhen](https://github.com/nomad/shenzhen)
 :checkered_flag: | Beautiful inline build output
-:book:     | helps you resolve common build errors like code signing issues
+:book:     | Helps you resolve common build errors like code signing issues
 :mountain_cableway: | Sensible defaults: Automatically detect the project, its schemes and more
 :link:  | Works perfectly with [fastlane](https://fastlane.tools) and other tools
 :package: | Automatically generates an `ipa` and a compressed `dSYM` file
 :bullettrain_side: | Don't remember any complicated build commands, just `gym`
 :wrench:  | Easy and dynamic configuration using parameters and environment variables
 :floppy_disk:   | Store common build settings in a `Gymfile` 
-:computer: | All archives are stored and accessible in the Xcode Organisier
+:computer: | All archives are stored and accessible in the Xcode Organizer
 
 ![/assets/gymScreenshot.png](/assets/gymScreenshot.png)
 
@@ -156,14 +156,13 @@ archive | xcpretty
 ```
 
 
-After building the archive it is being checked by `gym`. If it's valid, it gets packaged up and signed into an `ipa` file
+After building the archive it is being checked by `gym`. If it's valid, it gets packaged up and signed into an `ipa` file.
 
 ```
-xcodebuild -exportArchive -archivePath \
-'/Users/felixkrause/Library/Developer/Xcode/Archives/2015-08-11/ExampleProductName 2015-08-11 18.15.30.xcarchive' \
-exportFormat ipa \
--exportPath '/Users/felixkrause/Library/Developer/Xcode/Archives/2015-08-11/ExampleProductName.ipa' \
--exportProvisioningProfile 'Profile Name'
+/usr/bin/xcrun -sdk iphoneos PackageApplication -v \
+'/Users/felixkrause/Library/Developer/Xcode/Archives/2015-08-11/ExampleProductName 2015-08-11 18.15.30.xcarchive/Products/Applications/name.app' -o \
+'/Users/felixkrause/Library/Developer/Xcode/Archives/2015-08-11/ExampleProductName.ipa' \ 
+--sign "identity" --embed "provProfile"
 ```
 
 Afterwards the `ipa` file is moved to the output folder. The `dSYM` file is compressed and moved to the output folder as well.

data/lib/assets/package_application_patches/PackageApplication_MD5

@@ -0,0 +1 @@
+a434316d561ce5c4392a8447b58c18e7

data/lib/assets/package_application_patches/codesign_args_patch.diff

@@ -0,0 +1,33 @@
+From 13f2c76fd11b0d861ddf205d4d6ccc0c45a0d4b2 Mon Sep 17 00:00:00 2001
+From: Fabio Milano
+Date: Thu, 13 Aug 2015 15:02:41 +0200
+Subject: [PATCH] Fixed codesign_args
+
+---
+ PackageApplication4Gym | 8 +++++++-
+ 1 file changed, 7 insertions(+), 1 deletion(-)
+
+diff --git a/PackageApplication4Gym b/PackageApplication4Gym
+index fc4d7de..b97431f 100755
+--- a/PackageApplication4Gym
++++ b/PackageApplication4Gym
+@@ -152,9 +152,15 @@ if ( defined $opt{sign} ) {
+         }
+     }
+ 
+-    my @codesign_args = ("/usr/bin/codesign", "--force", "--preserve-metadata=identifier,entitlements,resource-rules",
++    my @codesign_args;
++    if (-e '$destApp/ResourceRules.plist') {  # If ResourceRules.plist exists, include it in codesign arguments, for backwards compatability
++        @codesign_args = ("/usr/bin/codesign", "--force", "--preserve-metadata=identifier,entitlements,resource-rules",
+                          "--sign", $opt{sign},
+                          "--resource-rules=$destApp/ResourceRules.plist");
++    } else { # If ResourceRules.plist isn't found, don't include it in the codesign arguments
++        @codesign_args = ("/usr/bin/codesign", "--force", "--preserve-metadata=identifier,entitlements",
++                         "--sign", $opt{sign});
++    }
+ 
+     if ( -e $entitlements_plist ) {
+         push(@codesign_args, '--entitlements');
+-- 
+2.2.1
+

data/lib/assets/package_application_patches/no_strict_parameter_patch.diff

@@ -0,0 +1,34 @@
+From 38ea965869a436c4b60e7dbfd5a28d42232d82d6 Mon Sep 17 00:00:00 2001
+From: Fabio Milano
+Date: Thu, 13 Aug 2015 16:03:26 +0200
+Subject: [PATCH] Added no-strict parameter
+
+---
+ PackageApplication4Gym | 4 ++--
+ 1 file changed, 2 insertions(+), 2 deletions(-)
+
+diff --git a/PackageApplication4Gym b/PackageApplication4Gym
+index 3085608..54a4b9e 100755
+--- a/PackageApplication4Gym
++++ b/PackageApplication4Gym
+@@ -92,7 +92,7 @@ foreach $plugin (@plugins) {
+     chomp $pluginName;
+     my $destPlugin = "$destAppDir/$pluginName";
+     
+-    my $result = runCmd("/usr/bin/codesign", "--verify", "-vvvv", , $plugin );
++    my $result = runCmd("/usr/bin/codesign", "--verify", "--no-strict", "-vvvv", , $plugin );
+     if ( $result !~ /valid on disk/ ) {
+         fatal("Codesign check fails : $result\n");
+     }
+@@ -111,7 +111,7 @@ if ( $opt{symbols} ) {
+ 
+ if ( $opt{verbose} ) {
+     print "### Checking original app\n";
+-    my $result = runCmd("/usr/bin/codesign", "--verify", "-vvvv", , $origApp );
++    my $result = runCmd("/usr/bin/codesign", "--verify", "--no-strict", "-vvvv", , $origApp );
+     if ( $result !~ /valid on disk/ ) {
+         print "Codesign check fails : $result\n";
+     }
+-- 
+2.2.1
+

data/lib/gym.rb

@@ -4,10 +4,12 @@ require 'gym/manager'
 require 'gym/project'
 require 'gym/build_command_generator'
 require 'gym/package_command_generator'
+require 'gym/commands_executor'
 require 'gym/runner'
 require 'gym/error_handler'
 require 'gym/options'
 require 'gym/detect_values'
+require 'gym/xcode_fix'
 
 require 'fastlane_core'
 require 'terminal-table'

data/lib/gym/build_command_generator.rb

@@ -40,7 +40,7 @@ module Gym
         options << "-sdk '#{config[:sdk]}'" if config[:sdk]
         options << "-destination '#{config[:destination]}'" if config[:destination]
         options << "-archivePath '#{archive_path}'"
-        options << "-xcargs '#{config[:xcargs]}'" if config[:xcargs]
+        options << config[:xcargs] if config[:xcargs]
 
         options
       end

data/lib/gym/commands_executor.rb

@@ -0,0 +1,53 @@
+module Gym
+  # Executes commands and takes care of error handling and more
+  module CommandsExecutor
+    # @param command [String] The command to be executed
+    # @param print_all [Boolean] Do we want to print out the command output while building?
+    #   If set to false, nothing will be printed
+    # @param error [Block] A block that's called if an error occurs
+    # @return [String] All the output as string
+    def self.execute(command: nil, print_all: false, error: nil)
+      print_all = true if $verbose
+
+      output = []
+      command = command.join(" ")
+      Helper.log.info command.yellow.strip unless Gym.config[:silent]
+
+      puts "\n-----".cyan if print_all
+
+      last_length = 0
+      begin
+        PTY.spawn(command) do |stdin, stdout, pid|
+          stdin.each do |l|
+            line = l.strip # strip so that \n gets removed
+            output << line
+
+            next unless print_all
+
+            current_length = line.length
+            spaces = [last_length - current_length, 0].max
+            print((line + " " * spaces + "\r").cyan)
+            last_length = current_length
+          end
+          Process.wait(pid)
+          puts "-----\n".cyan if print_all
+        end
+      rescue => ex
+        # This could happen when the environment is wrong:
+        # > invalid byte sequence in US-ASCII (ArgumentError)
+        output << ex.to_s
+        o = output.join("\n")
+        puts o
+        error.call(o)
+      end
+
+      # Exit status for build command, should be 0 if build succeeded
+      # Disabled Rubocop, since $CHILD_STATUS just is not the same
+      if $?.exitstatus != 0 # rubocop:disable Style/SpecialGlobalVars
+        o = output.join("\n")
+        puts o # the user has the right to see the raw output
+        error.call(o)
+      end
+    end
+  end
+end

data/lib/gym/detect_values.rb

@@ -50,12 +50,6 @@ module Gym
 
       if Gym.config[:provisioning_profile_path]
         FastlaneCore::ProvisioningProfile.install(Gym.config[:provisioning_profile_path])
-        data = FastlaneCore::ProvisioningProfile.parse(Gym.config[:provisioning_profile_path])
-
-        if data['Name']
-          Helper.log.info "Using provisioning profile with name '#{data['Name']}'...".green if $verbose
-          Gym.config[:provisioning_profile_name] = data['Name']
-        end
       end
     end
 

data/lib/gym/error_handler.rb

@@ -63,7 +63,7 @@ module Gym
           print "Make sure the name of the provisioning profile is correct"
           print "and it matches a locally installed profile"
           print "You can pass the name of the provisioning profile using the"
-          print "`--provisioning_profile_name` option"
+          print "`--provisioning_profile_path` option"
         when /mismatch between specified provisioning profile and signing identity/
           print "Mismatch between provisioning profile and code signing identity"
           print "This means, the specified provisioning profile was not created using"

data/lib/gym/manager.rb

@@ -16,10 +16,11 @@ module Gym
       rows << ["Project", config[:project]] if config[:project]
       rows << ["Workspace", config[:workspace]] if config[:workspace]
       rows << ["Scheme", config[:scheme]] if config[:scheme]
+      rows << ["Configuration", config[:configuration]] if config[:configuration]
 
       puts ""
       puts Terminal::Table.new(
-        title: "Building Application".green,
+        title: "Building Application 🚀".green,
         rows: rows
       )
       puts ""

data/lib/gym/options.rb

@@ -18,9 +18,10 @@ module Gym
                                      optional: true,
                                      description: "Path the workspace file",
                                      verify_block: proc do |value|
-                                       raise "Workspace file not found at path '#{File.expand_path(value)}'".red unless File.exist?(value.to_s)
-                                       raise "Workspace file invalid".red unless File.directory?(value.to_s)
-                                       raise "Workspace file is not a workspace, must end with .xcworkspace".red unless value.include?(".xcworkspace")
+                                       v = File.expand_path(value.to_s)
+                                       raise "Workspace file not found at path '#{v}'".red unless File.exist?(v)
+                                       raise "Workspace file invalid".red unless File.directory?(v)
+                                       raise "Workspace file is not a workspace, must end with .xcworkspace".red unless v.include?(".xcworkspace")
                                      end),
         FastlaneCore::ConfigItem.new(key: :project,
                                      short_option: "-p",
@@ -28,9 +29,10 @@ module Gym
                                      env_name: "GYM_PROJECT",
                                      description: "Path the project file",
                                      verify_block: proc do |value|
-                                       raise "Project file not found at path '#{File.expand_path(value)}'".red unless File.exist?(value.to_s)
-                                       raise "Project file invalid".red unless File.directory?(value.to_s)
-                                       raise "Project file is not a project file, must end with .xcodeproj".red unless value.include?(".xcodeproj")
+                                       v = File.expand_path(value.to_s)
+                                       raise "Project file not found at path '#{v}'".red unless File.exist?(v)
+                                       raise "Project file invalid".red unless File.directory?(v)
+                                       raise "Project file is not a project file, must end with .xcodeproj".red unless v.include?(".xcodeproj")
                                      end),
         FastlaneCore::ConfigItem.new(key: :provisioning_profile_path,
                                      short_option: "-e",
@@ -83,11 +85,6 @@ module Gym
                                      description: "Hide all information that's not necessary while building",
                                      default_value: false,
                                      is_string: false),
-        FastlaneCore::ConfigItem.new(key: :provisioning_profile_name,
-                                     short_option: "-l",
-                                     env_name: "GYM_PROVISIONING_PROFILE_NAME",
-                                     description: "The name of the provisioning profile to use. It has to match the name exactly",
-                                     optional: true),
         FastlaneCore::ConfigItem.new(key: :codesigning_identity,
                                      short_option: "-i",
                                      env_name: "GYM_CODE_SIGNING_IDENTITY",
@@ -101,7 +98,7 @@ module Gym
         FastlaneCore::ConfigItem.new(key: :xcargs,
                                      short_option: "-x",
                                      env_name: "GYM_XCARGS",
-                                     description: "Pass additional arguments to xcodebuild when building the app. Be sure to quote multiple args",
+                                     description: "Pass additional arguments to xcodebuild when building the app. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS=\"-ObjC -lstdc++\"",
                                      optional: true)
 
       ]

data/lib/gym/package_command_generator.rb

@@ -1,11 +1,17 @@
 module Gym
   # Responsible for building the fully working xcodebuild command
+  #
+  # Because of a known bug in PackageApplication Perl script used by Xcode the packaging process is performed with
+  # a patched version of the script.
   class PackageCommandGenerator
     class << self
       def generate
-        parts = ["/usr/bin/xcrun -sdk iphoneos PackageApplication -v"]
+        @patched_package_application = XcodeFix.patch_package_application
+
+        parts = ["/usr/bin/xcrun #{@patched_package_application} -v"]
         parts += options
         parts += pipe
+        parts += postfix
 
         parts
       end
@@ -17,8 +23,8 @@ module Gym
         options << "-o '#{ipa_path}'"
         options << "exportFormat ipa"
 
-        if Gym.config[:provisioning_profile_name]
-          options << "--embed '#{Gym.config[:provisioning_profile_name]}'"
+        if Gym.config[:provisioning_profile_path]
+          options << "--embed '#{Gym.config[:provisioning_profile_path]}'"
         end
 
         if Gym.config[:codesigning_identity]
@@ -32,6 +38,11 @@ module Gym
         [""]
       end
 
+      def postfix
+        # Remove the patched PackageApplication file after the export is finished
+        ["&& rm '#{@patched_package_application}'"]
+      end
+
       def appfile_path
         Dir.glob("#{BuildCommandGenerator.archive_path}/Products/Applications/*.app").first
       end

data/lib/gym/project.rb

@@ -78,16 +78,18 @@ module Gym
 
       return @raw if @raw
 
-      # We DO NOT want to pass the workspace, as this would also show
-      # all the CocoaPods schemes which we don't want here
-      containing_path = File.expand_path("..", path)
-      command = "xcrun xcodebuild -list"
+      # Unfortunately since we pass the workspace we also get all the
+      # schemes generated by CocoaPods
+
+      options = BuildCommandGenerator.project_path_array.delete_if { |a| a.to_s.include? "scheme" }
+      command = "xcrun xcodebuild -list #{options.join(' ')}"
       Helper.log.info command.yellow unless Gym.config[:silent]
 
-      Dir.chdir(containing_path) do
-        @raw = `#{command}`
-      end
-      @raw
+      @raw = `#{command}`.to_s
+
+      raise "Error parsing xcode file using `#{command}`".red if @raw.length == 0
+
+      return @raw
     end
   end
 end

data/lib/gym/runner.rb

@@ -9,6 +9,7 @@ module Gym
       build_app
       verify_archive
       package_app
+      swift_library_fix
       move_results
     end
 
@@ -55,7 +56,7 @@ module Gym
     def build_app
       command = BuildCommandGenerator.generate
       print_command(command, "Generated Build Command") if $verbose
-      execute_command(command: command, print_all: true, error: proc do |output|
+      Gym::CommandsExecutor.execute(command: command, print_all: true, error: proc do |output|
         ErrorHandler.handle_build_error(output)
       end)
 
@@ -74,11 +75,47 @@ module Gym
       command = PackageCommandGenerator.generate
       print_command(command, "Generated Package Command") if $verbose
 
-      execute_command(command: command, print_all: false, error: proc do |output|
+      Gym::CommandsExecutor.execute(command: command, print_all: false, error: proc do |output|
         ErrorHandler.handle_package_error(output)
       end)
     end
 
+    # Determine whether it is a Swift project and, eventually, include all required libraries to copy from Xcode's toolchain directory.
+    # Since there's no "xcodebuild" target to do just that, it is done post-build when exporting an archived build.
+    def swift_library_fix
+      require 'fileutils'
+
+      ipa_swift_frameworks = Dir["#{PackageCommandGenerator.appfile_path}/Frameworks/libswift*"]
+
+      unless ipa_swift_frameworks.empty?
+        Dir.mktmpdir do |tmpdir|
+          # Copy all necessary Swift libraries to a temporary "SwiftSupport" directory so that we can
+          # easily add it to the .ipa later.
+          swift_support = File.join(tmpdir, "SwiftSupport")
+
+          Dir.mkdir(swift_support)
+
+          developer_dir = `xcode-select --print-path`.strip
+          ipa_swift_frameworks.each do |path|
+            framework = File.basename(path)
+
+            FileUtils.copy_file("#{developer_dir}/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/iphoneos/#{framework}", File.join(swift_support, framework))
+          end
+
+          # Add "SwiftSupport" to the .ipa archive
+          Dir.chdir(tmpdir) do
+            command_parts = ["zip --recurse-paths #{PackageCommandGenerator.ipa_path} SwiftSupport"]
+            command_parts << "> /dev/null" unless $verbose
+            print_command(command_parts, "Fix Swift embedded code if needed") if $verbose
+
+            Gym::CommandsExecutor.execute(command: command_parts, print_all: false, error: proc do |output|
+              ErrorHandler.handle_package_error(output)
+            end)
+          end
+        end
+      end
+    end
+
     # Moves over the binary and dsym file to the output directory
     # @return (String) The path to the resulting ipa file
     def move_results
@@ -109,58 +146,5 @@ module Gym
       Helper.log.info ipa_path
       ipa_path
     end
-
-    #####################################################
-    # @!group Actually executing the commands
-    #####################################################
-
-    # @param command [String] The command to be executed
-    # @param print_all [Boolean] Do we want to print out the command output while building?
-    #   If set to false, nothing will be printed
-    # @param error [Block] A block that's called if an error occurs
-    # @return [String] All the output as string
-    def execute_command(command: nil, print_all: false, error: nil)
-      print_all = true if $verbose
-
-      output = []
-      command = command.join(" ")
-      Helper.log.info command.yellow.strip unless Gym.config[:silent]
-
-      puts "\n-----".cyan if print_all
-
-      last_length = 0
-      begin
-        PTY.spawn(command) do |stdin, stdout, pid|
-          stdin.each do |l|
-            line = l.strip # strip so that \n gets removed
-            output << line
-
-            next unless print_all
-
-            current_length = line.length
-            spaces = [last_length - current_length, 0].max
-            print((line + " " * spaces + "\r").cyan)
-            last_length = current_length
-          end
-          Process.wait(pid)
-          puts "-----\n".cyan if print_all
-        end
-      rescue => ex
-        # This could happen when the environment is wrong:
-        # > invalid byte sequence in US-ASCII (ArgumentError)
-        output << ex.to_s
-        o = output.join("\n")
-        puts o
-        error.call(o)
-      end
-
-      # Exit status for build command, should be 0 if build succeeded
-      # Disabled Rubocop, since $CHILD_STATUS just is not the same
-      if $?.exitstatus != 0 # rubocop:disable Style/SpecialGlobalVars
-        o = output.join("\n")
-        puts o # the user has the right to see the raw output
-        error.call(o)
-      end
-    end
   end
 end

data/lib/gym/version.rb

@@ -1,4 +1,4 @@
 module Gym
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
   DESCRIPTION = "Building your iOS apps has never been easier"
 end

data/lib/gym/xcode_fix.rb

@@ -0,0 +1,42 @@
+module Gym
+  class XcodeFix
+    class << self
+      # Fix PackageApplication Perl script by Xcode to create the IPA from the archive
+      def patch_package_application
+        require 'fileutils'
+
+        # Initialization
+        developer_dir = `xcode-select --print-path`.strip
+        patched_package_application_path = File.join("/tmp", "PackageApplication4Gym")
+        # Remove any previous patched PackageApplication
+        FileUtils.rm patched_package_application_path if File.exist?(patched_package_application_path)
+
+        Dir.mktmpdir do |tmpdir|
+          # Check current PackageApplication MD5
+          require 'digest'
+
+          path = File.join(Helper.gem_path("gym"), "lib/assets/package_application_patches/PackageApplication_MD5")
+          expected_md5 = File.read(path)
+
+          raise "Found an invalid `PackageApplication` script. This is not supported." unless expected_md5 == Digest::MD5.file("#{developer_dir}/Platforms/iPhoneOS.platform/Developer/usr/bin/PackageApplication").hexdigest
+
+          # Duplicate PackageApplication script to PackageApplication4Gym
+          FileUtils.copy_file("#{developer_dir}/Platforms/iPhoneOS.platform/Developer/usr/bin/PackageApplication", patched_package_application_path)
+
+          # Apply patches to PackageApplication4Gym from patches folder
+          Dir[File.join(Helper.gem_path("gym"), "lib/assets/package_application_patches/*.diff")].each do |patch|
+            Helper.log.info "Applying Package Application patch: #{File.basename(patch)}" unless Gym.config[:silent]
+            command = ["patch #{patched_package_application_path} < #{patch}"]
+            print_command(command, "Applying Package Application patch: #{File.basename(patch)}") if $verbose
+
+            Gym::CommandsExecutor.execute(command: command, print_all: false, error: proc do |output|
+              ErrorHandler.handle_build_error(output)
+            end)
+          end
+        end
+
+        return patched_package_application_path # Return path to the patched PackageApplication
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gym
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
@@ -190,8 +190,12 @@ files:
 - README.md
 - bin/gym
 - lib/assets/GymfileTemplate
+- lib/assets/package_application_patches/PackageApplication_MD5
+- lib/assets/package_application_patches/codesign_args_patch.diff
+- lib/assets/package_application_patches/no_strict_parameter_patch.diff
 - lib/gym.rb
 - lib/gym/build_command_generator.rb
+- lib/gym/commands_executor.rb
 - lib/gym/commands_generator.rb
 - lib/gym/detect_values.rb
 - lib/gym/error_handler.rb
@@ -201,6 +205,7 @@ files:
 - lib/gym/project.rb
 - lib/gym/runner.rb
 - lib/gym/version.rb
+- lib/gym/xcode_fix.rb
 homepage: https://fastlane.tools
 licenses:
 - MIT