xcodeproj 0.3.5 → 0.4.0.rc1

data/bin/xcodeproj

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+if $0 == __FILE__
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+  require "rubygems"
+  require "bundler/setup"
+  $:.unshift File.expand_path('../../ext', __FILE__)
+  $:.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'xcodeproj'
+
+Xcodeproj::Command.run(*ARGV)

data/lib/xcodeproj.rb

@@ -1,7 +1,19 @@
 module Xcodeproj
-  VERSION = '0.3.5'
+  VERSION = '0.4.0.rc1'
+
+  class PlainInformative < StandardError
+  end
+
+  class Informative < PlainInformative
+    def message
+      super !~ /\[!\]/ ? "[!] #{super}\n".red : super
+    end
+  end
 
   autoload :Config,    'xcodeproj/config'
+  autoload :Command,   'xcodeproj/command'
+  autoload :Constants, 'xcodeproj/constants'
+  autoload :Helper,    'xcodeproj/helper'
   autoload :Project,   'xcodeproj/project'
   autoload :Workspace, 'xcodeproj/workspace'
 end

data/lib/xcodeproj/command.rb

@@ -0,0 +1,131 @@
+module Xcodeproj
+
+  require 'colored'
+
+  class Command
+    autoload :TargetDiff,  'xcodeproj/command/target_diff'
+    autoload :ProjectDiff, 'xcodeproj/command/project_diff'
+    autoload :Show,        'xcodeproj/command/show'
+
+    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.inject(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 = ['target-diff', 'project-diff', 'show']
+      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 CocoaPods'],
+      ]
+    end
+
+    def self.run(*argv)
+      sub_command = parse(*argv)
+      sub_command.run
+
+    rescue Interrupt
+      puts "[!] Cancelled".red
+      Config.instance.verbose? ? raise : exit(1)
+
+    rescue Exception => e
+      puts e.message
+      puts *e.backtrace
+      exit 1
+    end
+
+    def self.parse(*argv)
+      argv = ARGV.new(argv)
+      if argv.option('--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 'target-diff'  then TargetDiff
+      when 'project-diff' then ProjectDiff
+      when 'show'         then Show
+      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)
+      end
+    end
+
+    def initialize(argv)
+      raise Help.new(self.class, argv)
+    end
+
+    def xcodeproj_path
+      unless @xcodeproj_path
+        projects = Dir.glob('*.xcodeproj')
+        if projects.size == 1
+          xcodeproj_path = projects.first
+        elsif projects.size > 1
+          raise Informative, 'There are more than one Xcode project documents ' \
+                             'in the current working directory. Please specify ' \
+                             'which to use with the `--project` option.'
+        else
+          raise Informative, 'No Xcode project document found in the current ' \
+                             'working directory. Please specify which to use ' \
+                             'with the `--project` option.'
+        end
+        @xcodeproj_path = File.expand_path(xcodeproj_path)
+      end
+      @xcodeproj_path
+    end
+
+    def xcodeproj
+      @xcodeproj ||= Project.new(xcodeproj_path)
+    end
+  end
+end
+

data/lib/xcodeproj/command/project_diff.rb

@@ -0,0 +1,53 @@
+module Xcodeproj
+  class Command
+    class ProjectDiff < Command
+      def self.banner
+%{Installing dependencies of a project:
+
+    $ project-diff PROJECT_1 PROJECT_2
+
+      Shows the difference between two projects in an UUID agnostic fashion.
+
+      To reduce the noise (and to simplify implementation) differences in the
+      other of arrays are ignored.
+}
+      end
+
+      def self.options
+        [ ["--ignore KEY", "A key to ignore in the comparison. Can be specified multiple times."] ].concat(super)
+      end
+
+      def initialize(argv)
+        @path_project1  = argv.shift_argument
+        @path_project2  = argv.shift_argument
+        @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?
+      end
+
+
+      def run
+        hash_1 = Project.new(@path_project1).to_tree_hash
+        hash_2 = Project.new(@path_project2).to_tree_hash
+        (@keys_to_ignore).each do |key|
+          hash_1.recursive_delete(key)
+          hash_2.recursive_delete(key)
+        end
+
+        diff = hash_1.recursive_diff(hash_2, @path_project1, @path_project2)
+        diff.recursive_delete('displayName')
+
+        require 'yaml'
+        yaml = diff.to_yaml
+        yaml = yaml.gsub(@path_project1, @path_project1.cyan)
+        yaml = yaml.gsub(@path_project2, @path_project2.magenta)
+        puts yaml
+      end
+    end
+  end
+end
+
+

data/lib/xcodeproj/command/show.rb

@@ -0,0 +1,35 @@
+module Xcodeproj
+  class Command
+    class Show < Command
+      def self.banner
+%{Installing dependencies of a project:
+
+    $ project-diff PROJECT_1 PROJECT_2
+
+      Shows a YAML reppresentation of a project.
+}
+      end
+
+      def self.options
+        [
+          ["--project PATH", "The Xcode project document to use."],
+        ].concat(super)
+      end
+
+      def initialize(argv)
+        if argv.option('--project')
+          @xcodeproj_path = File.expand_path(argv.shift_argument)
+        end
+        super unless argv.empty?
+      end
+
+      def run
+        require 'yaml'
+        yaml = xcodeproj.to_tree_hash.to_yaml
+        puts yaml
+      end
+    end
+  end
+end
+
+

data/lib/xcodeproj/command/target_diff.rb

@@ -0,0 +1,43 @@
+module Xcodeproj
+  class Command
+    class TargetDiff < Command
+      def self.banner
+%{Installing dependencies of a project:
+
+    $ targets-diff [target 1] [target 2]
+
+      Shows the difference between two targets. (Only build source files atm.)
+}
+      end
+
+      def self.options
+        [
+          ["--project PATH", "The Xcode project document to use."],
+        ].concat(super)
+      end
+
+      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?
+      end
+
+      def run
+        require 'yaml'
+        differ = Helper::TargetDiff.new(xcodeproj, @target1, @target2)
+        files = differ.new_source_build_files.map do |build_file|
+          {
+            'Name' => build_file.file_ref.name,
+            'Path' => build_file.file_ref.path,
+            'Build settings' => build_file.settings,
+          }
+        end
+        puts files.to_yaml
+      end
+    end
+  end
+end
+

data/lib/xcodeproj/config.rb

@@ -1,14 +1,41 @@
 module Xcodeproj
+
   # This class holds the data for a Xcode build settings file (xcconfig) and
   # serializes it.
+  #
   class Config
-    # Returns a new instance of Config
-    #
-    # @param [Hash, File, String] xcconfig_hash_or_file  Initial data.
+
     require 'set'
 
-    attr_accessor :attributes, :frameworks, :weak_frameworks ,:libraries
+    # @return [Hash{String => String}] The attributes of the settings file
+    #   excluding frameworks, weak_framework and libraries.
+    #
+    attr_accessor :attributes
+
+    # @return [Array<String>] The list of the frameworks required by this
+    #   settings file.
+    #
+    attr_accessor :frameworks
 
+    # @return [Array<String>] The list of the *weak* frameworks required by
+    #   this settings file.
+    #
+    attr_accessor :weak_frameworks
+
+    # @return [Array<String>] The list of the libraries required by this
+    #   settings file.
+    #
+    attr_accessor :libraries
+
+    # @return [Array] The list of the configuration files included by this
+    #   configuration file (`#include "SomeConfig"`).
+    #
+    attr_accessor :includes
+
+    # Returns a new instance of Config
+    #
+    # @param [Hash, File, String] xcconfig_hash_or_file  Initial data.
+    #
     def initialize(xcconfig_hash_or_file = {})
       @attributes = {}
       @includes = []
@@ -16,7 +43,34 @@ module Xcodeproj
       merge!(extract_hash(xcconfig_hash_or_file))
     end
 
-    # @return [Hash] The internal data.
+
+    #@! group Serialization
+
+    # Serializes the internal data in the xcconfig format.
+    #
+    # @example
+    #
+    #   config = Config.new('PODS_ROOT' => '"$(SRCROOT)/Pods"', 'OTHER_LDFLAGS' => '-lxml2')
+    #   config.to_s # => "PODS_ROOT = \"$(SRCROOT)/Pods\"\nOTHER_LDFLAGS = -lxml2"
+    #
+    # @return [String]  The serialized internal data.
+    def to_s
+      to_hash.map { |key, value| "#{key} = #{value}" }.join("\n")
+    end
+
+    # @return [void] Writes the serialized representation of the internal data
+    # to the given path.
+    #
+    # @param [Pathname] pathname  The file that the data should be written to.
+    #
+    def save_as(pathname)
+      pathname.open('w') { |file| file << to_s }
+    end
+
+    # @return [Hash] The hash reppresentation of the framework. The hash
+    # includes the frameworks, the weak frameworks and the libraries in the
+    # `Other Linker Flags` (`OTHER_LDFLAGS`).
+    #
     def to_hash
       hash = @attributes.dup
       flags = hash['OTHER_LDFLAGS'] || ''
@@ -29,23 +83,9 @@ module Xcodeproj
       hash
     end
 
-    def ==(other)
-      other.respond_to?(:to_hash) && other.to_hash == self.to_hash
-    end
 
-    # @return [Array] Config's include file list
-    # @example
-    #
-    # Consider following xcconfig file:
-    #
-    #   #include "SomeConfig"
-    #   Key1 = Value1
-    #   Key2 = Value2
-    #
-    #   config.includes # => [ "SomeConfig" ]
-    def includes
-      @includes
-    end
+
+    #@! group Merging
 
     # Merges the given xcconfig hash or Config into the internal data.
     #
@@ -59,6 +99,7 @@ module Xcodeproj
     #   config.to_hash # => { 'PODS_ROOT' => '"$(SRCROOT)/Pods"', 'OTHER_LDFLAGS' => '-lxml2 -lz', 'HEADER_SEARCH_PATHS' => '"$(PODS_ROOT)/Headers"' }
     #
     # @param [Hash, Config] xcconfig  The data to merge into the internal data.
+    #
     def merge!(xcconfig)
       if xcconfig.is_a? Config
         @attributes.merge!(xcconfig.attributes) { |key, v1, v2| "#{v1} #{v2}" }
@@ -95,28 +136,15 @@ module Xcodeproj
       Xcodeproj::Config.new(self.to_hash.dup)
     end
 
-    # Serializes the internal data in the xcconfig format.
-    #
-    # @example
-    #
-    #   config = Config.new('PODS_ROOT' => '"$(SRCROOT)/Pods"', 'OTHER_LDFLAGS' => '-lxml2')
-    #   config.to_s # => "PODS_ROOT = \"$(SRCROOT)/Pods\"\nOTHER_LDFLAGS = -lxml2"
-    #
-    # @return [String]  The serialized internal data.
-    def to_s
-      to_hash.map { |key, value| "#{key} = #{value}" }.join("\n")
-    end
+
+    #@! group Object methods
 
     def inspect
       to_hash.inspect
     end
 
-    # Writes the serialized representation of the internal data to the given
-    # path.
-    #
-    # @param [Pathname] pathname  The file that the data should be written to.
-    def save_as(pathname)
-      pathname.open('w') { |file| file << to_s }
+    def ==(other)
+      other.respond_to?(:to_hash) && other.to_hash == self.to_hash
     end
 
     private