censorius 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fae995832209c05c987ee10832a84697c712fa0625591bb048850e3e47833fb7
+  data.tar.gz: 5a9c760e0b96e41287f822b164ac7cb96793af5bc0cb9ad0ea8269f89d3f7a65
+SHA512:
+  metadata.gz: d7df4123bb5cee2b459b51e02bd1942dfab90a8674bbb21680d2ea40116051154dc91fb564ee642810ed0c862ce1cf6e5c47de1aed66b9970ef59987997bee53
+  data.tar.gz: 0c6c58313257a420935df61938e794f362a61dc681586a69f1a5c1c58ad47bba810e34622bd10dccaa5c34982dc741f8d08ae028e7464d4c8d4e5ea9ca6e626d

data/README.md

@@ -0,0 +1,66 @@
+# Censorius
+
+Censorius is a small gem that generates deterministic and stable UUID paths for [Xcodeproj](https://github.com/CocoaPods/Xcodeproj). It's meant to be used either with [CocoaPods](https://github.com/CocoaPods/CocoaPods) or [Xcake](https://github.com/igor-makarov/xcake) to reduce meaningless Xcode project file differences, and therefore make Xcode incremental builds after project generation shorter. 
+
+It is meant as a replacement for the `Xcodeproj::Project#predictabilize_uuids` method, which generates deterministic UUIDs in a way that is very unstable on even the smallest changes.
+
+Censorius covers all meaningful PBX file format elements. 
+
+## Why the name "Censorius"?
+
+In ancient Rome, a [censor](https://en.wikipedia.org/wiki/Roman_censor) was an official appointed to conduct the census, a process by which all of Rome's subjects were enumerated, and all their property was noted for the purpose of taxation.
+
+[Cato the Censor](https://en.wikipedia.org/wiki/Cato_the_Elder) was a Roman censor, who was mostly known for his catchphrase "Carthago delenda est" ("Carthage must be destroyed"), referring to the Carthaginian Empire that kept threatening and attacking Rome.
+
+The gem is named "Censorius" because it is my hope that with this final effort of conducting an object census of the Xcode project file, all the problems of the PBX file format will finally go away. _PBX delenda est._
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'censorius'
+```
+
+## Usage
+
+### With CocoaPods
+
+In your `Podfile`:
+```ruby
+require 'censorius'
+#
+# Define your dependencies...
+#
+# Remove the `deterministic_uuids` option if you're using it.
+#
+post_install do |installer|
+  installer.generated_projects.each do |project|
+    Censorius::UUIDGenerator.new([project]).generate!
+  end
+end
+```
+
+### With Xcake
+In your `Cakefile`:
+```ruby
+require 'censorius'
+#
+# Define your targets...
+#
+project.before_save do |main_project|
+  Censorius::UUIDGenerator.new([main_project]).generate!
+end
+
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/igor-makarov/censorius. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/igor-makarov/censorius/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Censorius project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/igor-makarov/censorius/blob/master/CODE_OF_CONDUCT.md).

data/lib/censorius.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'xcodeproj'
+
+require_relative 'censorius/version'
+
+module Censorius
+  # The main generator class
+  class UUIDGenerator < Xcodeproj::Project::UUIDGenerator
+    def generate_all_paths_by_objects(projects)
+      projects.each do |project|
+        generate_paths(project.root_object, project.path.basename.to_s)
+        without_path = project.objects.select { |o| @paths_by_object[o].nil? }
+        raise "Without paths: #{without_path}" unless without_path.empty?
+      end
+    end
+
+    def generate_paths(object, parent_path = '') # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      case object
+      when Xcodeproj::Project::Object::PBXProject
+        generate_paths_project(object)
+      when Xcodeproj::Project::Object::AbstractTarget
+        generate_paths_target(object, parent_path)
+      when Xcodeproj::Project::Object::PBXGroup
+        generate_paths_group(object)
+      when Xcodeproj::Project::Object::PBXFileReference
+        generate_paths_file_reference(object)
+      when Xcodeproj::Project::Object::XCConfigurationList
+        generate_paths_configuration_list(object, parent_path)
+      when Xcodeproj::Project::Object::XCBuildConfiguration
+        generate_paths_configuration(object, parent_path)
+      when Xcodeproj::Project::Object::AbstractBuildPhase
+        generate_paths_phase(object, parent_path)
+      when Xcodeproj::Project::Object::PBXBuildFile
+        generate_paths_build_file(object, parent_path)
+      when Xcodeproj::Project::Object::PBXContainerItemProxy
+        generate_paths_container_item_proxy(object, parent_path)
+      when Xcodeproj::Project::Object::PBXTargetDependency
+        generate_paths_target_dependency(object, parent_path)
+      when Xcodeproj::Project::Object::PBXReferenceProxy
+        generate_paths_reference_proxy(object, parent_path)
+      else
+        raise "Unrecognized: #{object.class}, at: #{parent_path}"
+      end
+
+      @paths_by_object[object]
+    end
+
+    def generate_paths_project(project)
+      @paths_by_object[project] = path = "PBXProject(#{project.name})"
+      generate_paths(project.main_group, path)
+      generate_paths(project.build_configuration_list, path)
+      project.targets.each do |target|
+        generate_paths(target, path)
+      end
+    end
+
+    def generate_paths_configuration_list(configuration_list, parent_path)
+      @paths_by_object[configuration_list] = path = "#{parent_path}/XCConfigurationList"
+      configuration_list.build_configurations.each do |config|
+        generate_paths(config, path)
+      end
+    end
+
+    def generate_paths_configuration(configuration, parent_path)
+      @paths_by_object[configuration] = "#{parent_path}/XCBuildConfiguration(#{configuration.name})"
+    end
+
+    def generate_paths_target(target, parent_path)
+      @paths_by_object[target] = path = "#{parent_path}/#{target.class.name.split('::').last}(#{target.name})"
+      target.build_phases.each do |phase|
+        generate_paths(phase, path)
+      end
+      generate_paths(target.build_configuration_list, path)
+      target.dependencies.each do |dependency|
+        generate_paths(dependency, path)
+      end
+    end
+
+    def generate_paths_phase(phase, parent_path)
+      @paths_by_object[phase] = path = "#{parent_path}/#{phase.class.name.split('::').last}(#{phase.display_name})"
+      phase.files.each do |file|
+        generate_paths(file, path)
+      end
+    end
+
+    def generate_paths_build_file(build_file, parent_path)
+      file_ref_path = generate_paths(build_file.file_ref)
+      @paths_by_object[build_file] = "#{parent_path}/PBXBuildFile(#{file_ref_path})"
+    end
+
+    def generate_paths_group(group)
+      project_path = @paths_by_object[group.project.root_object]
+      @paths_by_object[group] = path = "#{project_path}/PBXGroup(#{group.hierarchy_path || '/'})"
+      group.children.each do |child|
+        generate_paths(child, path)
+      end
+    end
+
+    def generate_paths_file_reference(file_reference)
+      project_path = @paths_by_object[file_reference.project.root_object]
+      @paths_by_object[file_reference] = "#{project_path}/PBXFileReference(#{file_reference.full_path})"
+    end
+
+    def generate_paths_target_dependency(dependency, parent_path)
+      raise "Unsupported: #{dependency}" unless dependency.target_proxy
+
+      @paths_by_object[dependency] = path = "#{parent_path}/PBXTargetDependency(#{dependency.name})"
+      generate_paths(dependency.target_proxy, path)
+    end
+
+    def generate_paths_container_item_proxy(proxy, parent_path)
+      params = [
+        "type: #{proxy.proxy_type}",
+        "containerPortal: #{proxy.container_portal_annotation.strip}",
+        "remoteInfo: #{proxy.remote_info}"
+      ]
+      @paths_by_object[proxy] = "#{parent_path}/PBXContainerItemProxy(#{params.join(', ')})"
+    end
+
+    def generate_paths_reference_proxy(proxy, parent_path)
+      @paths_by_object[proxy] = path = "#{parent_path}/PBXReferenceProxy(#{proxy.source_tree}/#{proxy.path})"
+      generate_paths(proxy.remote_ref, path) if proxy.remote_ref
+    end
+
+    def write_debug_paths
+      return if @projects.empty?
+
+      debug_info = @paths_by_object
+                   .to_a
+                   .map(&:last)
+                   .sort
+      file_name = @projects.count == 1 ? File.basename(@projects.first.path, '.*') : 'multi'
+      File.write("#{file_name}.txt", debug_info.join("\n"))
+    end
+  end
+end

data/lib/censorius/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Censorius
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: censorius
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Makarov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: PBX Delendare Est.
+email:
+- igormaka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/censorius.rb
+- lib/censorius/version.rb
+homepage: https://github.com/igor-makarov/censorius
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/igor-makarov/censorius
+  source_code_uri: https://github.com/igor-makarov/censorius
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A PBX UUID generator to end all generators.
+test_files: []