Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/CocoaPods/Rome

Makes it easy to build a list of frameworks.
https://github.com/CocoaPods/Rome

cocoapods dependency-manager dynamic-framework objective-c rome swift

Last synced: 3 months ago
JSON representation

Makes it easy to build a list of frameworks.

Host: GitHub
URL: https://github.com/CocoaPods/Rome
Owner: CocoaPods
License: mit
Created: 2015-03-21T02:35:56.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2021-03-18T12:59:54.000Z (over 3 years ago)
Last Synced: 2024-05-02T00:23:22.239Z (6 months ago)
Topics: cocoapods, dependency-manager, dynamic-framework, objective-c, rome, swift
Language: Ruby
Homepage:
Size: 106 KB
Stars: 694
Watchers: 20
Forks: 64
Open Issues: 23
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# cocoapods-rome

![](yolo.jpg)

Rome makes it easy to build a list of frameworks for consumption outside of
Xcode, e.g. for a Swift script.

## Installation

```bash
$ gem install cocoapods-rome
```

## Important

In the examples below the target 'caesar' could either be an existing target of a project managed by cocapods for which you'd like to run a swift script **or** it could be fictitious, for example if you wish to run this on a standalone Podfile and get the frameworks you need for adding to your xcode project manually.

## Usage

Write a simple Podfile, like this:

### MacOS

```ruby
platform :osx, '10.10'

plugin 'cocoapods-rome'

target 'caesar' do
pod 'Alamofire'
end
```

### iOS

```ruby
platform :ios, '8.0'

plugin 'cocoapods-rome', { :pre_compile => Proc.new { |installer|
installer.pods_project.targets.each do |target|
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '4.0'
end
end

installer.pods_project.save
},

dsym: false,
configuration: 'Release'
}

target 'caesar' do
pod 'Alamofire'
end
```

then run this:

```bash
pod install
```

and you will end up with dynamic frameworks:

```
$ tree Rome/
Rome/
└── Alamofire.framework
```

## Advanced Usage

For your production builds, when you want dSYMs created and stored:

```ruby
platform :osx, '10.10'

plugin 'cocoapods-rome', {
dsym: true,
configuration: 'Release'
}

target 'caesar' do
pod 'Alamofire'
end
```

Resulting in:

```
$ tree dSYM/
dSYM/
├── iphoneos
│   └── Alamofire.framework.dSYM
│   └── Contents
│   ├── Info.plist
│   └── Resources
│   └── DWARF
│   └── Alamofire
└── iphonesimulator
└── Alamofire.framework.dSYM
└── Contents
├── Info.plist
└── Resources
└── DWARF
└── Alamofire
```

## Hooks

The plugin allows you to provides hooks that will be called during the installation process.

### `pre_compile`

This hook allows you to make any last changes to the generated Xcode project before the compilation of frameworks begins.

It receives the `Pod::Installer` as its only argument.

### `post_compile`

This hook allows you to run code after the compilation of the frameworks finished and they have been moved to the `Rome` folder.

It receives the `Pod::Installer` as its only argument.

#### Example

Customising the Swift version of all pods

```ruby
platform :osx, '10.10'

plugin 'cocoapods-rome',
:pre_compile => Proc.new { |installer|
installer.pods_project.targets.each do |target|
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '4.0'
end
end

installer.pods_project.save
},
:post_compile => Proc.new { |installer|
puts "Rome finished building all the frameworks"
}

target 'caesar' do
pod 'Alamofire'
end
```