xcodeproj 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 362652d47890e422884822cbddea7e111300f631
-  data.tar.gz: 530b5a22dc14ef0af7f4564f57be23cd850c3f4e
+  metadata.gz: 2c231842b2ee35dc87dd3005deff2ef60557a9fe
+  data.tar.gz: 78d9bb3482208d8d9d66584ef465de0c28909988
 SHA512:
-  metadata.gz: cb7de4876f0254a035c46d339f084c872a539c38d3dab4f491ad26fb2c2814c85ea997ba0fcb149dbab9b3bf693cfd06cefa99af7fb35337d9ac0eec397986e2
-  data.tar.gz: 10195a51baf29a6af0e4daba851e41b5c77a9ce8a452848d176332a1ccff63c723db828a58b3a4f9504328a738c8665daf005ebbb641b2c229d0d53d4c433d45
+  metadata.gz: 1e530ccfdd06efed97f4ae18e44b892a0fbeaa4da6fedf4ef53f0e56682bf6a5b83e575669223e652f402b7ccf9b9e989866fe45d0a3263825a1a605ee59f0b4
+  data.tar.gz: 2fc50ec63b9e481de45afaae65a0ce544323b5fe90e36da80b8e5a1c7511ef74f7b5a8a489c6dfe90632eca55f47cb0766d4671be0e6af6ddaeda2f6035864ff

data/bin/xcodeproj

@@ -10,4 +10,4 @@ end
 
 require 'xcodeproj'
 
-Xcodeproj::Command.run(*ARGV)
+Xcodeproj::Command.run(ARGV)

data/lib/xcodeproj.rb

@@ -1,7 +1,9 @@
 module Xcodeproj
   require 'pathname'
+  require 'claide'
 
   class PlainInformative < StandardError
+    include CLAide::InformativeError
   end
 
   class Informative < PlainInformative

data/lib/xcodeproj/command.rb

@@ -1,126 +1,28 @@
 module Xcodeproj
   require 'colored'
+  require 'claide'
 
-  class Command
-    autoload :ConfigDump,  'xcodeproj/command/config_dump'
-    autoload :TargetDiff,  'xcodeproj/command/target_diff'
-    autoload :ProjectDiff, 'xcodeproj/command/project_diff'
-    autoload :Show,        'xcodeproj/command/show'
-    autoload :Sort,        'xcodeproj/command/sort'
+  class Command < CLAide::Command
+    require 'xcodeproj/command/config_dump'
+    require 'xcodeproj/command/target_diff'
+    require 'xcodeproj/command/project_diff'
+    require 'xcodeproj/command/show'
+    require 'xcodeproj/command/sort'
 
-    class Help < StandardError
-      def initialize(command_class, argv, unrecognized_command = nil)
-        @command_class, @argv, @unrecognized_command = command_class, argv, unrecognized_command
-      end
-
-      def message
-        message = [
-          '',
-          @command_class.banner.gsub(/\$ pod (.*)/, '$ pod \1'.green),
-          '',
-          'Options:',
-          '',
-          options,
-          "\n",
-        ].join("\n")
-        message << "[!] Unrecognized command: `#{@unrecognized_command}'\n".red if @unrecognized_command
-        message << "[!] Unrecognized argument#{@argv.count > 1 ? 's' : ''}: `#{@argv.join(' - ')}'\n".red unless @argv.empty?
-        message
-      end
-
-      private
-
-      def options
-        options  = @command_class.options
-        keys     = options.map(&:first)
-        key_size = keys.reduce(0) { |size, key| key.size > size ? key.size : size }
-        options.map { |key, desc| "    #{key.ljust(key_size)}   #{desc}" }.join("\n")
-      end
-    end
-
-    class ARGV < Array
-      def options
-        select { |x| x.to_s[0, 1] == '-' }
-      end
-
-      def arguments
-        self - options
-      end
-
-      def option(name)
-        !!delete(name)
-      end
-
-      def shift_argument
-        (arg = arguments[0]) && delete(arg)
-      end
-    end
-
-    def self.banner
-      commands = ['config-dump', 'target-diff', 'project-diff', 'show', 'sort']
-      banner   = "To see help for the available commands run:\n\n"
-      banner + commands.map { |cmd| "  * $ xcodeproj #{cmd.green} --help" }.join("\n")
-    end
-
-    def self.options
-      [
-        ['--help',     'Show help information'],
-        # ['--silent',   'Print nothing'],
-        # ['--no-color', 'Print output without color'],
-        # ['--verbose',  'Print more information while working'],
-        ['--version',  'Prints the version of Xcodeproj'],
-      ]
-    end
+    self.abstract_command = true
+    self.command = 'xcodeproj'
+    self.version = VERSION
+    self.description = 'Xcodeproj lets you create and modify Xcode projects from Ruby.'
+    self.plugin_prefixes = %w(claide xcodeproj)
 
-    def self.run(*argv)
-      sub_command = parse(*argv)
-      sub_command.run
-
-    rescue Interrupt
-      puts '[!] Cancelled'.red
-      # Config.instance.verbose? ? raise : exit(1)
-      exit(1)
-
-    rescue => e
-      puts e.message
-      unless e.is_a?(Informative) || e.is_a?(Help)
-        puts e.backtrace
-      end
-      exit 1
-    end
-
-    def self.parse(*argv)
-      argv = ARGV.new(argv)
-      if argv.option('--version')
-        require 'xcodeproj/gem_version'
-        puts VERSION
-        exit!(0)
-      end
-
-      show_help = argv.option('--help')
-
-      String.send(:define_method, :colorize) { |string, _| string } if argv.option('--no-color')
-
-      command_class = case command_argument = argv.shift_argument
-                      when 'config-dump'  then ConfigDump
-                      when 'target-diff'  then TargetDiff
-                      when 'project-diff' then ProjectDiff
-                      when 'show'         then Show
-                      when 'sort'         then Sort
-                      end
-
-      if command_class.nil?
-        raise Help.new(self, argv, command_argument)
-      elsif show_help
-        raise Help.new(command_class, argv)
-      else
-        command_class.new(argv)
+    def initialize(argv)
+      super
+      unless self.ansi_output?
+        String.send(:define_method, :colorize) { |string, _| string }
       end
     end
 
-    def initialize(argv)
-      raise Help.new(self.class, argv)
-    end
+    private
 
     def xcodeproj_path
       unless @xcodeproj_path
@@ -136,11 +38,23 @@ module Xcodeproj
                              'working directory. Please specify which to use ' \
                              'with the `--project` option.'
         end
-        @xcodeproj_path = File.expand_path(xcodeproj_path)
+        @xcodeproj_path = Pathname.new(xcodeproj_path).expand_path
       end
       @xcodeproj_path
     end
 
+    def open_project!(*paths)
+      if paths.empty?
+        [xcodeproj]
+      else
+        paths.map { |path| Project.open(path) }
+      end
+    end
+
+    def xcodeproj_path=(path)
+      @xcodeproj_path = path && Pathname.new(path).expand_path
+    end
+
     def xcodeproj
       @xcodeproj ||= Project.open(xcodeproj_path)
     end

data/lib/xcodeproj/command/config_dump.rb

@@ -1,24 +1,28 @@
 module Xcodeproj
   class Command
     class ConfigDump < Command
-      def self.banner
-        require 'active_support/core_ext/string/strip.rb'
-        <<-eos.strip_heredoc
+      self.description = <<-eos
         Dumps the build settings of all project targets for all configurations in
         directories named by the target in given output directory.
 
-            $ config-dump PROJECT OUTPUT
+        It extracts common build settings in a per target base.xcconfig file.
 
-              It extracts common build settings in a per target base.xcconfig file.
-              If no `PROJECT` is specified then the current work directory is searched
-              for one.
-              If no `OUTPUT` is specified then the project directory will be used.%)
+        If no `PROJECT` is specified then the current work directory is searched
+        for one.
+
+        If no `OUTPUT` is specified then the project directory will be used.
         eos
-      end
+
+      self.summary = 'Dumps the build settings of all project targets for ' \
+                     'all configurations in directories named by the target ' \
+                     'in the given output directory.'
+
+      self.arguments = [
+        CLAide::Argument.new('PROJECT', false),
+      ]
 
       def initialize(argv)
-        xcodeproj_path = argv.shift_argument
-        @xcodeproj_path = File.expand_path(xcodeproj_path) if xcodeproj_path
+        self.xcodeproj_path = argv.shift_argument
 
         @output_path  = Pathname(argv.shift_argument || '.')
         unless @output_path.directory?
@@ -28,6 +32,11 @@ module Xcodeproj
         super unless argv.empty?
       end
 
+      def validate!
+        super
+        open_project!
+      end
+
       def run
         dump_all_configs(xcodeproj, 'Project')
 

data/lib/xcodeproj/command/project_diff.rb

@@ -1,38 +1,42 @@
 module Xcodeproj
   class Command
     class ProjectDiff < Command
-      def self.banner
-        %{Shows the difference between two projects:
+      self.summary = 'Shows the difference between two projects'
 
-            $ project-diff PROJECT_1 PROJECT_2
+      self.description = summary + <<-EOS.gsub(/ {8}/, '')
 
-              It shows the difference in a UUID agnostic fashion.
+        It shows the difference in a UUID agnostic fashion.
 
-              To reduce the noise (and to simplify implementation) differences in the
-              order of arrays are ignored.}
-      end
+        To reduce the noise (and to simplify implementation) differences in the
+        order of arrays are ignored.
+      EOS
 
       def self.options
-        [['--ignore KEY', 'A key to ignore in the comparison. Can be specified multiple times.']].concat(super)
+        [
+          ['--ignore=KEY', 'A key to ignore in the comparison. Can be specified multiple times.'],
+        ].concat(super)
       end
 
+      self.arguments = [
+        CLAide::Argument.new('PROJECT1', true),
+        CLAide::Argument.new('PROJECT2', true),
+      ]
+
       def initialize(argv)
         @path_project1  = argv.shift_argument
         @path_project2  = argv.shift_argument
-        unless @path_project1 && @path_project2
-          raise Informative, 'Two project paths are required.'
-        end
-        @keys_to_ignore = []
-        while (idx = argv.index('--ignore'))
-          @keys_to_ignore << argv.delete_at(idx + 1)
-          argv.delete_at(idx)
-        end
-        super unless argv.empty?
+        @keys_to_ignore = argv.all_options('ignore')
+        super
+      end
+
+      def validate!
+        super
+        @project1, @project2 = open_project!(@path_project1, @path_project2)
       end
 
       def run
-        hash_1 = Project.new(@path_project1).to_tree_hash.dup
-        hash_2 = Project.new(@path_project2).to_tree_hash.dup
+        hash_1 = @project1.to_tree_hash.dup
+        hash_2 = @project2.to_tree_hash.dup
         @keys_to_ignore.each do |key|
           Differ.clean_hash!(hash_1, key)
           Differ.clean_hash!(hash_2, key)
@@ -42,9 +46,9 @@ module Xcodeproj
 
         require 'yaml'
         yaml = diff.to_yaml
-        yaml = yaml.gsub(@path_project1, @path_project1.cyan)
-        yaml = yaml.gsub(@path_project2, @path_project2.magenta)
-        yaml = yaml.gsub(':diff:', 'diff:'.yellow)
+        yaml.gsub!(@path_project1, @path_project1.cyan)
+        yaml.gsub!(@path_project2, @path_project2.magenta)
+        yaml.gsub!(':diff:', 'diff:'.yellow)
         puts yaml
       end
     end

data/lib/xcodeproj/command/show.rb

@@ -1,45 +1,44 @@
 module Xcodeproj
   class Command
     class Show < Command
-      def self.banner
-        %(Shows an overview of a project in a YAML representation.'
-
-            $ show [PROJECT]
-
-              If no `PROJECT' is specified then the current work directory is searched
-              for one.)
-      end
+      self.summary = 'Shows an overview of a project in a YAML representation.'
 
       def self.options
         [
-          ['--format [hash|tree_hash|raw]', 'YAML output format, optional'],
+          ['--format=[hash|tree_hash|raw]', 'YAML output format'],
         ].concat(super)
       end
 
+      self.arguments = [
+        CLAide::Argument.new('PROJECT', false),
+      ]
+
       def initialize(argv)
-        xcodeproj_path = argv.shift_argument
-        @xcodeproj_path = File.expand_path(xcodeproj_path) if xcodeproj_path
+        self.xcodeproj_path = argv.shift_argument
+        @output_format = argv.option('format')
+        @output_format &&= @output_format.to_sym
+        super
+      end
 
-        if argv.option('--format')
-          @output_format = argv.shift_argument
+      def validate
+        super
+        unless [nil, :hash, :tree_hash, :raw].include?(@output_format)
+          help! "Unknown format `#{@output_format}`"
         end
-
-        super unless argv.empty?
+        open_project!
       end
 
       def run
         require 'yaml'
 
         if @output_format
-          case @output_format.to_sym
+          case @output_format
           when :hash
             puts xcodeproj.to_hash.to_yaml
           when :tree_hash
             puts xcodeproj.to_tree_hash.to_yaml
           when :raw
             puts xcodeproj.to_yaml
-          else
-            raise Informative, "Unknowh format #{@output_format}!"
           end
           return
         end

data/lib/xcodeproj/command/sort.rb

@@ -1,19 +1,26 @@
 module Xcodeproj
   class Command
     class Sort < Command
-      def self.banner
-        %(Sorts the give project
+      self.description = <<-eos
+        Sorts the given project.
 
-            $ sort [PROJECT]
+        If no `PROJECT' is specified then the current work directory is searched for one.
+      eos
 
-              If no `PROJECT' is specified then the current work directory is searched
-              for one.)
-      end
+      self.summary = 'Sorts the give project.'
+
+      self.arguments = [
+        CLAide::Argument.new('PROJECT', false),
+      ]
 
       def initialize(argv)
-        xcodeproj_path = argv.shift_argument
-        @xcodeproj_path = File.expand_path(xcodeproj_path) if xcodeproj_path
-        super unless argv.empty?
+        self.xcodeproj_path = argv.shift_argument
+        super
+      end
+
+      def validate!
+        super
+        open_project!
       end
 
       def run

data/lib/xcodeproj/command/target_diff.rb

@@ -1,13 +1,7 @@
 module Xcodeproj
   class Command
     class TargetDiff < Command
-      def self.banner
-        %(Shows the difference between two targets:
-
-            $ targets-diff [target 1] [target 2]
-
-              Only supports build source files atm.)
-      end
+      self.summary = 'Shows the difference between two targets'
 
       def self.options
         [
@@ -15,13 +9,21 @@ module Xcodeproj
         ].concat(super)
       end
 
+      self.arguments = [
+        CLAide::Argument.new('TARGET1', true),
+        CLAide::Argument.new('TARGET2', true),
+      ]
+
       def initialize(argv)
         @target1 = argv.shift_argument
         @target2 = argv.shift_argument
-        if argv.option('--project')
-          @xcodeproj_path = File.expand_path(argv.shift_argument)
-        end
-        super unless argv.empty?
+        self.xcodeproj_path = argv.option('--project')
+        super
+      end
+
+      def validate!
+        super
+        open_project!
       end
 
       def run

data/lib/xcodeproj/gem_version.rb

@@ -1,5 +1,5 @@
 module Xcodeproj
   # The version of the xcodeproj gem.
   #
-  VERSION = '0.25.1' unless defined? Xcodeproj::VERSION
+  VERSION = '0.26.0' unless defined? Xcodeproj::VERSION
 end

data/lib/xcodeproj/project.rb

@@ -3,6 +3,7 @@ require 'securerandom'
 
 require 'xcodeproj/project/object'
 require 'xcodeproj/project/project_helper'
+require 'xcodeproj/project/uuid_generator'
 require 'xcodeproj/plist_helper'
 
 module Xcodeproj
@@ -321,6 +322,21 @@ module Xcodeproj
       Xcodeproj.write_plist(to_hash, file)
     end
 
+    # Replaces all the UUIDs in the project with deterministic MD5 checksums.
+    #
+    # @note The current sorting of the project is taken into account when
+    #       generating the new UUIDs.
+    #
+    # @note This method should only be used for entirely machine-generated
+    #       projects, as true UUIDs are useful for tracking changes in the
+    #       project.
+    #
+    # @return [void]
+    #
+    def predictabilize_uuids
+      UUIDGenerator.new(self).generate!
+    end
+
     public
 
     # @!group Creating objects

data/lib/xcodeproj/project/uuid_generator.rb

@@ -0,0 +1,100 @@
+module Xcodeproj
+  class Project
+    class UUIDGenerator
+      def initialize(project)
+        @project = project
+        @new_objects_by_uuid = {}
+        @paths_by_object = {}
+      end
+
+      def generate!
+        all_objects = @project.objects
+        generate_paths(@project.root_object)
+        switch_uuids(all_objects)
+        verify_no_duplicates!(all_objects)
+        fixup_uuid_references
+        @project.instance_variable_set(:@generated_uuids, @project.instance_variable_get(:@available_uuids))
+        @project.instance_variable_set(:@objects_by_uuid, @new_objects_by_uuid)
+      end
+
+      private
+
+      def verify_no_duplicates!(all_objects)
+        duplicates = all_objects - @new_objects_by_uuid.values
+        raise "[Xcodeproj] Generated duplicate UUIDs:\n\n" <<
+          duplicates.map { |d| "#{d.isa} -- #{@paths_by_object[d]}" }.join("\n") unless duplicates.empty?
+      end
+
+      def fixup_uuid_references
+        fixup = ->(object, attr) do
+          if object.respond_to?(attr) && link = @project.objects_by_uuid[object.send(attr)]
+            object.send(:"#{attr}=", link.uuid)
+          end
+        end
+        @project.objects.each do |object|
+          [:remote_global_id_string, :container_portal, :target_proxy].each do |attr|
+            fixup[object, attr]
+          end
+        end
+      end
+
+      def generate_paths(object, path = '')
+        @paths_by_object[object] = path
+
+        object.to_one_attributes.each do |attrb|
+          obj = attrb.get_value(object)
+          generate_paths(obj, path + '/' << attrb.plist_name) if obj
+        end
+
+        object.to_many_attributes.each do |attrb|
+          attrb.get_value(object).each do |o|
+            generate_paths(o, path + '/' << attrb.plist_name << "/#{path_component_for_object(o)}")
+          end
+        end
+
+        object.references_by_keys_attributes.each do |attrb|
+          attrb.get_value(object).each do |dictionary|
+            dictionary.each do |key, value|
+              generate_paths(value, path + '/' << attrb.plist_name << "/k:#{key}/#{path_component_for_object(value)}")
+            end
+          end
+        end
+      end
+
+      def switch_uuids(objects)
+        objects.each do |object|
+          next unless path = @paths_by_object[object]
+          uuid = uuid_for_path(path)
+          object.instance_variable_set(:@uuid, uuid)
+          @new_objects_by_uuid[uuid] = object
+        end
+      end
+
+      def uuid_for_path(path)
+        Digest::MD5.hexdigest(path).upcase
+      end
+
+      def path_component_for_object(object)
+        hash = object.to_tree_hash
+        tree_hash_to_path(hash)
+      end
+
+      def tree_hash_to_path(object)
+        case object
+        when Hash
+          object.sort.each_with_object('') do |(key, value), string|
+            string << key << ':' << tree_hash_to_path(value) << ','
+          end
+        when Array
+          object.map do |value|
+            tree_hash_to_path(value)
+          end.join(',')
+        when String
+          object
+        else
+          raise "[Xcodeproj] Unrecognized object `#{hash}` in #tree_hash_to_path"
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: xcodeproj
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Eloy Duran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-27 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: claide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: Xcodeproj lets you create and modify Xcode projects from Ruby. Script
   boring management tasks or build Xcode-friendly libraries. Also includes support
   for Xcode workspaces (.xcworkspace) and configuration files (.xcconfig).
@@ -85,6 +99,7 @@ files:
 - lib/xcodeproj/project/object_dictionary.rb
 - lib/xcodeproj/project/object_list.rb
 - lib/xcodeproj/project/project_helper.rb
+- lib/xcodeproj/project/uuid_generator.rb
 - lib/xcodeproj/scheme.rb
 - lib/xcodeproj/user_interface.rb
 - lib/xcodeproj/workspace.rb
@@ -100,12 +115,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []