ccios
Xcode File Generator for Clean Code architecture
How to install
gem install ccios
To build it from source:
cd ccios
gem build ccios.gemspec
gem install ./ccios-x.x.x.gem
To run the tests run:
rake test
How to use
Go to your .xcodeproj
folder cd /paht/to/my/xcodeproj
.
Then generate files with prefix Example
:
ccios [-p|-i|-r|-c] Example [-d]
Generated templates can be found here
-p
-p
stands for presenter
This generates 4 files: ExampleViewController
, ExampleViewContract
, ExamplePresenter
, ExamplePresenterImplementation
. If the -d
option is supplied the protocol ExamplePresenterDelegate
will be generated.
What's more it prints the code you need to add to DependencyProvider.swift
and PresenterAssembly.swift
for dependency injection.
The following structure is created for you in the Xcode project:
.
+-- App/
| +-- Example/
| | +-- UI/
| | | +-- View/
| | | +-- ViewController/
| | | | +-- ExampleViewController
| | | +-- ExampleViewContract
| | +-- Presenter/
| | | +-- ExamplePresenter
| | | +-- ExamplePresenterImplementation
| | +-- Model/
-i
-i
stands for interactor
This generates 2 files: ExampleInteractor
and ExampleInteractorImplementation
.
What's more it prints the code you need to add to InteractorAssembly.swift
for dependency injection.
The following structure is created for you in the Xcode project:
.
+-- Core/
| +-- Interactor/
| | +-- ExampleInteractor/
| | | +-- ExampleInteractor
| | | +-- ExampleInteractorImplementation
-r
-r
stands for repository
This generates 2 files: ExampleRepository
and ExampleRepositoryImplementation
.
What's more it prints the code you need to add to RepositoryAssembly.swift
for dependency injection.
The following structure is created for you in the Xcode project:
.
+-- Core/
| +-- Data/
| | +-- Example
| | | +-- ExampleRepository
+-- Data/
| +-- Example
| | +-- ExampleRepositoryImplementation
-c
-c
stands for coordinator
This generates one file: ExampleCoordinator
. If the -d
option is supplied the protocol ExampleCoordinatorDelegate
will be generated.
The following structure is created for you in the Xcode project:
.
+-- Coordinator/
| +-- ExampleCoordinator
Configuration
Each project is different. You can configure the groups to use in the xcodeproj for the new files.
Create a file .ccios.yml
at the root of your project.
By default, if no file is present, the following configuration will be used:
app:
project: MyProject.xcodeproj
presenter:
group: Classes/App
coordinator:
group: Classes/Coordinator
core:
project: MyProject.xcodeproj
interactor:
group: Classes/Core/Interactor
repository:
group: Classes/Core/Data
data:
project: MyProject.xcodeproj
repository:
group: Classes/Data
But you could imagine more complex project structures with multiple xcodeproj:
app:
project: MyProject/MyProject.xcodeproj
target: MyProject # optional
presenter:
group: Classes/App
coordinator:
group: Classes/Coordinator
core:
project: MyProjectCore/MyProjectCore.xcodeproj
target: MyProjectCore # optional
interactor:
group: MyProjectCore/Interactors
repository:
group: MyProjectCore/Repository
data:
project: MyProjectData/MyProjectData.xcodeproj
target: MyProjectData # optional
repository:
group: MyProjectData/Sources/Repositories
Note: The path of the new files will be infered from the path of the group. It works with Group with folder and Group without folder in Xcode.