plasmo_xcodeproj 1.21.1

data/lib/xcodeproj/workspace.rb

@@ -0,0 +1,277 @@
+require 'fileutils'
+require 'rexml/document'
+require 'xcodeproj/workspace/file_reference'
+require 'xcodeproj/workspace/group_reference'
+
+module Xcodeproj
+  # Provides support for generating, reading and serializing Xcode Workspace
+  # documents.
+  #
+  class Workspace
+    # @return [REXML::Document] the parsed XML model for the workspace contents
+    attr_reader :document
+
+    # @return [Hash<String => String>] a mapping from scheme name to project full path
+    #         containing the scheme
+    attr_reader :schemes
+
+    # @return [Array<FileReference>] the paths of the projects contained in the
+    #         workspace.
+    #
+    def file_references
+      return [] unless @document
+      @document.get_elements('/Workspace//FileRef').map do |node|
+        FileReference.from_node(node)
+      end
+    end
+
+    # @return [Array<GroupReference>] the groups contained in the workspace
+    #
+    def group_references
+      return [] unless @document
+      @document.get_elements('/Workspace//Group').map do |node|
+        GroupReference.from_node(node)
+      end
+    end
+
+    # @param [REXML::Document] document @see document
+    # @param [Array<FileReference>] file_references additional projects to add
+    #
+    # @note The document parameter is passed to the << operator if it is not a
+    #       valid REXML::Document. It is optional, but may also be passed as nil
+    #
+    def initialize(document, *file_references)
+      @schemes = {}
+      if document.nil?
+        @document = REXML::Document.new(root_xml(''))
+      elsif document.is_a?(REXML::Document)
+        @document = document
+      else
+        @document = REXML::Document.new(root_xml(''))
+        self << document
+      end
+      file_references.each { |ref| self << ref }
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Returns a workspace generated by reading the contents of the given path.
+    #
+    # @param  [String] path
+    #         the path of the `xcworkspace` file.
+    #
+    # @return [Workspace] the generated workspace.
+    #
+    def self.new_from_xcworkspace(path)
+      from_s(File.read(File.join(path, 'contents.xcworkspacedata')),
+             File.expand_path(path))
+    rescue Errno::ENOENT
+      new(nil)
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Returns a workspace generated by reading the contents of the given
+    # XML representation.
+    #
+    # @param  [String] xml
+    #         the XML representation of the workspace.
+    #
+    # @return [Workspace] the generated workspace.
+    #
+    def self.from_s(xml, workspace_path = '')
+      document = REXML::Document.new(xml)
+      instance = new(document)
+      instance.load_schemes(workspace_path)
+      instance
+    end
+
+    # Adds a new path to the list of the of projects contained in the
+    # workspace.
+    # @param [String, Xcodeproj::Workspace::FileReference] path_or_reference
+    #        A string or Xcode::Workspace::FileReference containing a path to an Xcode project
+    #
+    # @raise [ArgumentError] Raised if the input is neither a String nor a FileReference
+    #
+    # @return [void]
+    #
+    def <<(path_or_reference)
+      return unless @document && @document.respond_to?(:root)
+
+      case path_or_reference
+      when String
+        project_file_reference = Xcodeproj::Workspace::FileReference.new(path_or_reference)
+      when Xcodeproj::Workspace::FileReference
+        project_file_reference = path_or_reference
+        projpath = nil
+      else
+        raise ArgumentError, "Input to the << operator must be a file path or FileReference, got #{path_or_reference.inspect}"
+      end
+      unless file_references.any? { |ref| project_file_reference.eql? ref }
+        @document.root.add_element(project_file_reference.to_node)
+      end
+      load_schemes_from_project File.expand_path(projpath || project_file_reference.path)
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Adds a new group container to the workspace
+    # workspace.
+    #
+    # @param  [String] name The name of the group
+    #
+    # @yield [Xcodeproj::Workspace::GroupReference, REXML::Element]
+    #        Yields the GroupReference and underlying XML element for mutation
+    #
+    # @return [Xcodeproj::Workspace::GroupReference] The added group reference
+    #
+    def add_group(name)
+      return nil unless @document
+      group = Xcodeproj::Workspace::GroupReference.new(name)
+      elem = @document.root.add_element(group.to_node)
+      yield group, elem if block_given?
+      group
+    end
+
+    # Checks if the workspace contains the project with the given file
+    # reference.
+    #
+    # @param  [FileReference] file_reference
+    #         The file_reference to the project.
+    #
+    # @return [Boolean] whether the project is contained in the workspace.
+    #
+    def include?(file_reference)
+      file_references.include?(file_reference)
+    end
+
+    # @return [String] the XML representation of the workspace.
+    #
+    def to_s
+      contents = ''
+      stack = []
+      @document.root.each_recursive do |elem|
+        until stack.empty?
+          last = stack.last
+          break if last == elem.parent
+          contents += xcworkspace_element_end_xml(stack.length, last)
+          stack.pop
+        end
+
+        stack << elem
+        contents += xcworkspace_element_start_xml(stack.length, elem)
+      end
+
+      until stack.empty?
+        contents += xcworkspace_element_end_xml(stack.length, stack.last)
+        stack.pop
+      end
+
+      root_xml(contents)
+    end
+
+    # Saves the workspace at the given `xcworkspace` path.
+    #
+    # @param  [String] path
+    #         the path where to save the project.
+    #
+    # @return [void]
+    #
+    def save_as(path)
+      FileUtils.mkdir_p(path)
+      File.open(File.join(path, 'contents.xcworkspacedata'), 'w') do |out|
+        out << to_s
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Load all schemes from all projects in workspace or in the workspace container itself
+    #
+    # @param [String] workspace_dir_path
+    #         path of workspaces dir
+    #
+    # @return [void]
+    #
+    def load_schemes(workspace_dir_path)
+      # Normalizes path to directory of workspace needed for file_reference.absolute_path
+      workspaces_dir = workspace_dir_path
+      if File.extname(workspace_dir_path) == '.xcworkspace'
+        workspaces_dir = File.expand_path('..', workspaces_dir)
+      end
+
+      file_references.each do |file_reference|
+        project_full_path = file_reference.absolute_path(workspaces_dir)
+        load_schemes_from_project(project_full_path)
+      end
+
+      # Load schemes that are in the workspace container.
+      workspace_abs_path = File.absolute_path(workspace_dir_path)
+      Dir[File.join(workspace_dir_path, 'xcshareddata', 'xcschemes', '*.xcscheme')].each do |scheme|
+        scheme_name = File.basename(scheme, '.xcscheme')
+        @schemes[scheme_name] = workspace_abs_path
+      end
+    end
+
+    private
+
+    # Load all schemes from project
+    #
+    # @param [String] project_full_path
+    #         project full path
+    #
+    # @return [void]
+    #
+    def load_schemes_from_project(project_full_path)
+      schemes = Xcodeproj::Project.schemes project_full_path
+      schemes.each do |scheme_name|
+        @schemes[scheme_name] = project_full_path
+      end
+    end
+
+    # @return [String] The template of the workspace XML as formated by Xcode.
+    #
+    # @param  [String] contents The XML contents of the workspace.
+    #
+    def root_xml(contents)
+      <<-DOC
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+#{contents.rstrip}
+</Workspace>
+DOC
+    end
+
+    #
+    # @param  [Integer] depth The depth of the element in the tree
+    # @param  [REXML::Document::Element] elem The XML element to format.
+    #
+    # @return [String] The Xcode-specific XML formatting of an element start
+    #
+    def xcworkspace_element_start_xml(depth, elem)
+      attributes = case elem.name
+                   when 'Group'
+                     %w(location name)
+                   when 'FileRef'
+                     %w(location)
+                   end
+      contents = "<#{elem.name}"
+      indent = '   ' * depth
+      attributes.each { |name| contents += "\n   #{name} = \"#{elem.attribute(name)}\"" }
+      contents.split("\n").map { |line| "#{indent}#{line}" }.join("\n") + ">\n"
+    end
+
+    #
+    # @param  [Integer] depth The depth of the element in the tree
+    # @param  [REXML::Document::Element] elem The XML element to format.
+    #
+    # @return [String] The Xcode-specific XML formatting of an element end
+    #
+    def xcworkspace_element_end_xml(depth, elem)
+      "#{'   ' * depth}</#{elem.name}>\n"
+    end
+
+    #-------------------------------------------------------------------------#
+  end
+end

data/lib/xcodeproj/xcodebuild_helper.rb

@@ -0,0 +1,108 @@
+module Xcodeproj
+  # Helper class which returns information from xcodebuild.
+  #
+  class XcodebuildHelper
+    def initialize
+      @needs_to_parse_sdks = true
+    end
+
+    # @return [String] The version of the last iOS sdk.
+    #
+    def last_ios_sdk
+      parse_sdks_if_needed
+      versions_by_sdk[:ios].sort.last
+    end
+
+    # @return [String] The version of the last OS X sdk.
+    #
+    def last_osx_sdk
+      parse_sdks_if_needed
+      versions_by_sdk[:osx].sort.last
+    end
+
+    # @return [String] The version of the last tvOS sdk.
+    #
+    def last_tvos_sdk
+      parse_sdks_if_needed
+      versions_by_sdk[:tvos].sort.last
+    end
+
+    # @return [String] The version of the last watchOS sdk.
+    #
+    def last_watchos_sdk
+      parse_sdks_if_needed
+      versions_by_sdk[:watchos].sort.last
+    end
+
+    private
+
+    # !@group Private Helpers
+
+    #-------------------------------------------------------------------------#
+
+    # @return [Hash] The versions of the sdks grouped by name (`:ios`, or `:osx`).
+    #
+    attr_accessor :versions_by_sdk
+
+    # @return [void] Parses the SDKs returned by xcodebuild and stores the
+    #         information in the `needs_to_parse_sdks` hash.
+    #
+    def parse_sdks_if_needed
+      if @needs_to_parse_sdks
+        @versions_by_sdk = {}
+        @versions_by_sdk[:osx] = []
+        @versions_by_sdk[:ios] = []
+        @versions_by_sdk[:tvos] = []
+        @versions_by_sdk[:watchos] = []
+        if xcodebuild_available?
+          sdks = parse_sdks_information(xcodebuild_sdks)
+          sdks.each do |(name, version)|
+            case
+            when name == 'macosx' then @versions_by_sdk[:osx] << version
+            when name == 'iphoneos' then @versions_by_sdk[:ios] << version
+            when name == 'appletvos' then @versions_by_sdk[:tvos] << version
+            when name == 'watchos' then @versions_by_sdk[:watchos] << version
+            end
+          end
+        end
+      end
+    end
+
+    # @return [Bool] Whether xcodebuild is available.
+    #
+    def xcodebuild_available?
+      if @xcodebuild_available.nil?
+        `which xcodebuild 2>/dev/null`
+        @xcodebuild_available = $?.exitstatus.zero?
+      end
+      @xcodebuild_available
+    end
+
+    # @return [Array<Array<String>>] An array of tuples where the first element
+    #         is the name of the SDK and the second is the version.
+    #
+    def parse_sdks_information(output)
+      output.scan(/-sdk (macosx|iphoneos|watchos|appletvos)(.+\w)/)
+    end
+
+    # @return [String] The sdk information reported by xcodebuild.
+    #
+    def xcodebuild_sdks
+      `xcodebuild -showsdks 2>/dev/null`
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Singleton
+
+    # @return [XcodebuildHelper] the current xcodebuild instance creating one
+    #         if needed, which caches the information from the xcodebuild
+    #         command line tool.
+    #
+    def self.instance
+      @instance ||= new
+    end
+
+    #-------------------------------------------------------------------------#
+  end
+end

data/lib/xcodeproj.rb

@@ -0,0 +1,29 @@
+module Xcodeproj
+  require 'pathname'
+  require 'claide'
+  require 'colored2'
+
+  class PlainInformative < StandardError
+    include CLAide::InformativeError
+  end
+
+  class Informative < PlainInformative
+    def message
+      super !~ /\[!\]/ ? "[!] #{super}\n".red : super
+    end
+  end
+
+  require 'xcodeproj/gem_version'
+  require 'xcodeproj/user_interface'
+
+  autoload :Command,          'xcodeproj/command'
+  autoload :Config,           'xcodeproj/config'
+  autoload :Constants,        'xcodeproj/constants'
+  autoload :Differ,           'xcodeproj/differ'
+  autoload :Helper,           'xcodeproj/helper'
+  autoload :Plist,            'xcodeproj/plist'
+  autoload :Project,          'xcodeproj/project'
+  autoload :Workspace,        'xcodeproj/workspace'
+  autoload :XCScheme,         'xcodeproj/scheme'
+  autoload :XcodebuildHelper, 'xcodeproj/xcodebuild_helper'
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: plasmo_xcodeproj
+version: !ruby/object:Gem::Version
+  version: 1.21.1
+platform: ruby
+authors:
+- Daniel Sinclair
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: atomos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: claide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: colored2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: nanaimo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.4
+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).
+email: d@niel.nyc
+executables:
+- xcodeproj
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/xcodeproj
+- lib/xcodeproj.rb
+- lib/xcodeproj/command.rb
+- lib/xcodeproj/command/config_dump.rb
+- lib/xcodeproj/command/project_diff.rb
+- lib/xcodeproj/command/show.rb
+- lib/xcodeproj/command/sort.rb
+- lib/xcodeproj/command/target_diff.rb
+- lib/xcodeproj/config.rb
+- lib/xcodeproj/config/other_linker_flags_parser.rb
+- lib/xcodeproj/constants.rb
+- lib/xcodeproj/differ.rb
+- lib/xcodeproj/gem_version.rb
+- lib/xcodeproj/helper.rb
+- lib/xcodeproj/plist.rb
+- lib/xcodeproj/project.rb
+- lib/xcodeproj/project/case_converter.rb
+- lib/xcodeproj/project/object.rb
+- lib/xcodeproj/project/object/build_configuration.rb
+- lib/xcodeproj/project/object/build_file.rb
+- lib/xcodeproj/project/object/build_phase.rb
+- lib/xcodeproj/project/object/build_rule.rb
+- lib/xcodeproj/project/object/configuration_list.rb
+- lib/xcodeproj/project/object/container_item_proxy.rb
+- lib/xcodeproj/project/object/file_reference.rb
+- lib/xcodeproj/project/object/group.rb
+- lib/xcodeproj/project/object/helpers/build_settings_array_settings_by_object_version.rb
+- lib/xcodeproj/project/object/helpers/file_references_factory.rb
+- lib/xcodeproj/project/object/helpers/groupable_helper.rb
+- lib/xcodeproj/project/object/native_target.rb
+- lib/xcodeproj/project/object/reference_proxy.rb
+- lib/xcodeproj/project/object/root_object.rb
+- lib/xcodeproj/project/object/swift_package_product_dependency.rb
+- lib/xcodeproj/project/object/swift_package_remote_reference.rb
+- lib/xcodeproj/project/object/target_dependency.rb
+- lib/xcodeproj/project/object_attributes.rb
+- 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/scheme/abstract_scheme_action.rb
+- lib/xcodeproj/scheme/analyze_action.rb
+- lib/xcodeproj/scheme/archive_action.rb
+- lib/xcodeproj/scheme/build_action.rb
+- lib/xcodeproj/scheme/buildable_product_runnable.rb
+- lib/xcodeproj/scheme/buildable_reference.rb
+- lib/xcodeproj/scheme/command_line_arguments.rb
+- lib/xcodeproj/scheme/environment_variables.rb
+- lib/xcodeproj/scheme/execution_action.rb
+- lib/xcodeproj/scheme/launch_action.rb
+- lib/xcodeproj/scheme/location_scenario_reference.rb
+- lib/xcodeproj/scheme/macro_expansion.rb
+- lib/xcodeproj/scheme/profile_action.rb
+- lib/xcodeproj/scheme/remote_runnable.rb
+- lib/xcodeproj/scheme/send_email_action_content.rb
+- lib/xcodeproj/scheme/shell_script_action_content.rb
+- lib/xcodeproj/scheme/test_action.rb
+- lib/xcodeproj/scheme/xml_element_wrapper.rb
+- lib/xcodeproj/user_interface.rb
+- lib/xcodeproj/workspace.rb
+- lib/xcodeproj/workspace/file_reference.rb
+- lib/xcodeproj/workspace/group_reference.rb
+- lib/xcodeproj/workspace/reference.rb
+- lib/xcodeproj/xcodebuild_helper.rb
+homepage: https://github.com/DanielSinclair/Xcodeproj
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 3
+summary: Create and modify Xcode projects from Ruby.
+test_files: []