Censorius

Censorius is a small gem that generates deterministic and stable UUID paths for Xcodeproj. It's meant to be used either with CocoaPods or 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 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 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:

gem 'censorius'

Usage

With CocoaPods

In your Podfile:

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:

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.

License

The gem is available as open source under the terms of the MIT License.

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.