update_xcode_plugins 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5ce0bbcfbf2d527792780fc1a3ae1f15c98abba
-  data.tar.gz: 13899945ad14710cb46c46f62db1e87a9527ee51
+  metadata.gz: cdd300916ae49b90352b93a1a4a6cc89e841a1e4
+  data.tar.gz: 83895ce167a3d682a4b71d7e5fa1ce0c46651408
 SHA512:
-  metadata.gz: cff0d8a41328ba10c57e4a6c317dd60baf3644bbbc3ea7df82abb87c8fd25fc359a1f23ee03e078124d3a24c6fd9709a696a5d182427fad5f4249c44e1ec0c5a
-  data.tar.gz: 9ca6de1c58a65f7104973e5e8f2b8c97b826f60a284ac2cb142b726a1741b7f2ae94089aa6758dd4fe294395a3bb812249cd07ce6c4fc6097543aefef0e4bc2f
+  metadata.gz: 690f81863d024b3d3987eddcaa975ab136fd765c6eeba94376d15104744193b448e3326467034cf5157502f1632a9afbc0401f4ba6e5ca398f77de0ea3193ccd
+  data.tar.gz: 7b0df2e488c171afd8d5be1ed10c700b2e59581241b49e2901a698f1f5934c284b5ed83105c78b9c8abac0a639f638078be81fd3a2e75348aed4baa430bb93b5

data/README.md

@@ -1,13 +1,19 @@
-![](https://travis-ci.org/inket/update_xcode_plugins.svg?branch=master)
+[![](https://travis-ci.org/inket/update_xcode_plugins.svg?branch=master)](https://travis-ci.org/inket/update_xcode_plugins) [![Coverage Status](https://coveralls.io/repos/github/inket/update_xcode_plugins/badge.svg?branch=master)](https://coveralls.io/github/inket/update_xcode_plugins?branch=master)
+
+![](https://img.shields.io/badge/xcode%207.3-supported-brightgreen.svg) ![](https://img.shields.io/badge/xcode%208.0-supported-brightgreen.svg) ![](https://img.shields.io/badge/xcode%208.1-supported-brightgreen.svg) ![](https://img.shields.io/badge/xcode%208.2-supported-brightgreen.svg)
 
 ### $ update\_xcode\_plugins
 
-This tool adds the missing UUIDs into the installed Xcode plug-ins so that they can be loaded by newer versions of Xcode.
+This tool adds the missing UUIDs into the installed Xcode plugins so that they can be loaded by newer versions of Xcode.
 
 You can choose to run it once or install a **launch agent** that will trigger the tool every time any of your installed plugins are modified or Xcode/Xcode-beta gets updated.
 
 This tool also allows you to unsign Xcode in order to run plugins on Xcode 8 and later. For more information on why this is needed, see [alcatraz/Alcatraz#475](https://github.com/alcatraz/Alcatraz/issues/475).
 
+When unsigning Xcode, you will also be prompted to unsign `xcodebuild`; Doing so will allow `xcodebuild` to load plugins and silence the library validation warnings. More info at [#8](https://github.com/inket/update_xcode_plugins/issues/8#issuecomment-247881598).
+
+If you are having any issues, please check [common issues](#common-issues) before creating an issue.
+
 #### Install
 
 ```shell
@@ -16,6 +22,8 @@ $ gem install update_xcode_plugins
 
 (if using system ruby: `sudo gem install update_xcode_plugins`)
 
+(if still having problems: `sudo gem install -n /usr/local/bin update_xcode_plugins` [#10](https://github.com/inket/update_xcode_plugins/issues/10))
+
 #### Usage
 
 In Terminal:
@@ -32,12 +40,12 @@ To use plugins on Xcode 8 and later, unsign Xcode with:
 $ update_xcode_plugins --unsign
 ```
 
-![](http://i.imgur.com/3044DnB.png)
+![](http://i.imgur.com/XUco0su.png)
 
-If you need to unsign without creating a copy of Xcode, at your own risk, use the command:
+If you need to restore Xcode, use the command:
 
 ```shell
-$ update_xcode_plugins --unsafe-unsign
+$ update_xcode_plugins --restore
 ```
 
 ##### Other options
@@ -60,6 +68,12 @@ or to uninstall the launch agent,
 $ update_xcode_plugins --uninstall-launch-agent
 ```
 
+##### Common Issues
+
+###### Xcode crashes:
+
+  One or more of the plugins you are using are incompatible with your version of Xcode and are causing it to crash. The crash report will generally include the name of the responsible plugin. If unsure, start removing your plugins one by one until you find the culprit.
+
 #### Contact
 
 [@inket](https://github.com/inket) / [@inket](https://twitter.com/inket) on Twitter / [mahdi.jp](https://mahdi.jp)

data/bin/update_xcode_plugins

@@ -2,23 +2,28 @@
 
 require_relative '../lib/update_xcode_plugins'
 
-if CLI.uninstall_launch_agent?
-  LaunchAgent.uninstall
-else
-  LaunchAgent.update_if_stale(__FILE__)
-
-  if CLI.install_launch_agent?
-    LaunchAgent.install(__FILE__)
-  elsif CLI.unsign_xcode?
-    XcodeUnsigner.unsign_xcode
+begin
+  if CLI.uninstall_launch_agent?
+    LaunchAgent.uninstall
   else
-    if CLI.non_interactive?
-      # This tool is ran by launchctl whenever a plugin is added/modified,
-      # which presents a race condition if the plugin is still in the process
-      # of being modified. Counter that by sleeping for a few seconds.
-      sleep 2
-    end
+    LaunchAgent.update_if_stale(__FILE__)
 
-    PluginsUpdater.update_plugins
+    if CLI.install_launch_agent?
+      LaunchAgent.install(__FILE__)
+    elsif CLI.unsign_xcode?
+      XcodeUnsigner.unsign_xcode
+    elsif CLI.restore_xcode?
+      XcodeUnsigner.restore_xcode
+    else
+      if CLI.non_interactive?
+        # This tool is ran by launchctl whenever a plugin is added/modified,
+        # which presents a race condition if the plugin is still in the process
+        # of being modified. Counter that by sleeping for a few seconds.
+        sleep 2
+      end
+
+      PluginsUpdater.update_plugins
+    end
   end
+rescue Interrupt
 end

data/lib/cli.rb

@@ -12,11 +12,11 @@ module CLI
   end
 
   def self.unsign_xcode?
-    ARGV.include?('--unsign') || ARGV.include?('--unsafe-unsign')
+    ARGV.include?('--unsign')
   end
 
-  def self.unsafe_unsign_xcode?
-    ARGV.include?('--unsafe-unsign')
+  def self.restore_xcode?
+    ARGV.include?('--restore')
   end
 
   def self.no_colors?
@@ -31,9 +31,27 @@ module CLI
     `which codesign` && $CHILD_STATUS.exitstatus == 0
   end
 
+  def self.chown_if_required(path)
+    return yield if File.owned?(path)
+
+    puts
+    puts "* Changing ownership of #{path} (will be restored after)".colorize(:light_blue)
+
+    previous_owner = File.stat(path).uid
+    system("sudo chown $(whoami) \"#{path}\"")
+
+    raise "Could not change ownership of #{path}" unless File.owned?(path)
+
+    result = yield
+    system("sudo chown #{previous_owner} \"#{path}\"")
+    puts "* Restored ownership of #{path}".colorize(:light_blue)
+
+    result
+  end
+
   {
     title: :blue,
-    process: :magenta,
+    process: :light_blue,
     warning: :yellow,
     error: :red,
     success: :green

data/lib/plugins_updater.rb

@@ -12,7 +12,7 @@ class PluginsUpdater
       return
     else
       title 'Found:'
-      puts xcodes.map { |s| "- #{s}" }
+      puts xcodes.map { |xcode| "- #{xcode.detailed_description}" }
     end
 
     separator

data/lib/version.rb

@@ -1,3 +1,3 @@
 class UpdateXcodePlugins
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/xcode.rb

@@ -43,6 +43,18 @@ class Xcode < Bundle
     signed
   end
 
+  def restorable?
+    binary_restorable? || xcodebuild_restorable?
+  end
+
+  def binary_restorable?
+    File.exist?("#{binary_path}.signed")
+  end
+
+  def xcodebuild_restorable?
+    File.exist?("#{xcodebuild_path}.signed")
+  end
+
   def unsign_binary!
     unsign!(binary_path)
   end
@@ -51,16 +63,28 @@ class Xcode < Bundle
     unsign!(xcodebuild_path)
   end
 
+  def restore_binary!
+    restore!(binary_path)
+  end
+
+  def restore_xcodebuild!
+    restore!(xcodebuild_path)
+  end
+
   def uuid
     defaults_read('DVTPlugInCompatibilityUUID')
   end
 
   def to_s
     unless signed.nil?
-      codesign_status = signed ? '[Signed]' : '[Unsigned]'
+      codesign_status = signed ? ' [Signed]' : ' [Unsigned]'
     end
 
-    "Xcode (#{version}) [#{uuid}]#{codesign_status}: #{path}"
+    "Xcode (#{version})#{codesign_status}: #{path}"
+  end
+
+  def detailed_description
+    "Xcode (#{version}) [#{uuid}]: #{path}"
   end
 
   private
@@ -81,10 +105,25 @@ class Xcode < Bundle
 
   def unsign!(target)
     unsigned_target = "#{target}.unsigned"
+    signed_target = "#{target}.signed"
+
+    CLI.chown_if_required(File.dirname(target)) do
+      `#{unsign_path} "#{target}"` &&
+        $CHILD_STATUS.exitstatus == 0
+        File.exist?(unsigned_target) &&
+        FileUtils.mv(target, signed_target) &&
+        File.exist?(signed_target) &&
+        FileUtils.mv(unsigned_target, target)
+    end
+  end
 
-    `#{unsign_path} "#{target}"` &&
-      $CHILD_STATUS.exitstatus == 0 &&
-      File.exist?(unsigned_target) &&
-      FileUtils.mv(unsigned_target, target)
+  def restore!(target)
+    signed_target = "#{target}.signed"
+
+    CLI.chown_if_required(File.dirname(target)) do
+      File.exist?(signed_target) &&
+        File.exist?(target) &&
+        FileUtils.mv(signed_target, target)
+    end
   end
 end

data/lib/xcode_unsigner.rb

@@ -4,13 +4,6 @@ class XcodeUnsigner
   extend CLI
 
   def self.unsign_xcode
-    unless CLI.codesign_exists?
-      # Not sure if codesign comes pre-installed on fresh macOS, so we'll check
-      # Send a pull request if you think it does :)
-      error 'The `codesign` tool could not be found on your system'
-      return
-    end
-
     process 'Looking for Xcode...'
     xcodes = Xcode.find_xcodes
                   .select { |xcode| xcode.version.to_f >= 8 }
@@ -19,68 +12,76 @@ class XcodeUnsigner
     separator
 
     if xcodes.empty?
-      error "Didn't find any Xcode 8+ installed on your system."
+      error "Didn't find any signed Xcode 8+ on your system."
       return
-    else
-      puts notice
-      puts copy_notice unless CLI.unsafe_unsign_xcode?
     end
 
+    notice
     separator
 
-    selection = Ask.list prompt, ['Cancel', xcodes].flatten
-    return unless selection && selection != 0
+    selection = Ask.list "Choose which Xcode you would like to unsign (use arrows)", xcodes
+    return unless selection
 
-    xcode = xcodes[selection - 1]
+    xcode = xcodes[selection]
 
     unsign_xcodebuild = Ask.confirm "Unsign xcodebuild too?"
 
-    if CLI.unsafe_unsign_xcode?
-      new_xcode = xcode
-    else
-      new_xcode_path = '/Applications/Xcode-unsigned.app'
-      if Dir.exist?(new_xcode_path)
-        error 'Xcode-unsigned.app already exists.'
-        return
-      end
-
-      process 'Copying Xcode... (this might take a while)'
-      FileUtils.cp_r(xcode.path, new_xcode_path)
-      new_xcode = Xcode.new(new_xcode_path)
-    end
+    separator
 
     process 'Unsigning...'
-    if new_xcode.unsign_binary! &&
-       (!unsign_xcodebuild || (unsign_xcodebuild && new_xcode.unsign_xcodebuild!))
+    if xcode.unsign_binary! &&
+       (!unsign_xcodebuild || (unsign_xcodebuild && xcode.unsign_xcodebuild!))
       success 'Finished! 🎉'
     else
-      error "Could not unsign #{File.basename(new_xcode.path)}\n"\
+      error "Could not unsign #{xcode.path}\n"\
             'Create an issue on https://github.com/inket/update_xcode_plugins/issues'
     end
   end
 
+  def self.restore_xcode
+    process 'Looking for Xcode...'
+    xcodes = Xcode.find_xcodes
+                  .select { |xcode| xcode.version.to_f >= 8 }
+                  .select(&:restorable?)
+
+    separator
+
+    if xcodes.empty?
+      error "Didn't find any Xcode 8+ that can be restored on your system."
+      return
+    end
+
+    selection = Ask.list "Choose which Xcode you would like to restore (use arrows)", xcodes
+    return unless selection
+
+    xcode = xcodes[selection]
+
+    separator
+
+    process 'Restoring...'
+
+    success = true
+
+    if xcode.binary_restorable? && !xcode.restore_binary!
+      error "Could not restore binary for #{xcode.path}"
+      success = false
+    end
+
+    if xcode.xcodebuild_restorable? && !xcode.restore_xcodebuild!
+      error "Could not restore xcodebuild for #{xcode.path}"
+      success = false
+    end
+
+    success 'Finished! 🎉' if success
+  end
+
   def self.notice
-    [
+    puts [
       'Unsigning Xcode will make it skip library validation allowing it to load plugins.'.colorize(:yellow),
-      '',
       'However, an unsigned Xcode presents security risks, '\
       'and will be untrusted by both Apple and your system.'.colorize(:red),
-      'Please make sure that you have launched this version of Xcode at least '\
-      'once before unsigning.'.colorize(:red)
-    ]
-  end
-
-  def self.copy_notice
-    [
-      'We recommend keeping a signed version of Xcode, so this tool will:',
-      '- Create a copy of Xcode.app called Xcode-unsigned.app (consider the disk space requirements)',
-      '- Unsign Xcode-unsigned.app'
+      "This tool will create a backup and allow you to restore Xcode's signature by running\n",
+      '$ update_xcode_plugins --restore'.colorize(:light_blue)
     ]
   end
-
-  def self.prompt
-    "Choose which Xcode.app you would like to "\
-    "#{CLI.unsafe_unsign_xcode? ? '' : 'copy and '}"\
-    "unsign (use arrows)"
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: update_xcode_plugins
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Mahdi Bchetnia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: update_xcode_plugins
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Updates Xcode plug-ins to match the installed Xcode versions.