How to create your own CocoaPods framework

Hello Everyone,

I hope you are well aware with CocoaPods and how to use this inside your XCode projects. If you are not well aware, follow my previous blog about how to use CocoaPods.

Now it is time to learn to build your own Pod framework.

Setup – What you need?

  • git account.
  • Make sure git is installed in your Mac machine. Because we will do all git commands from terminal only. (using source tree or any other application for git commands is not recommended)
  • Make sure your system is updated and you have latest Ruby Gems installed.
    $ sudo gem update --system
  • Install CocoaPods if you don’t have Pods installed in your Mac machine.
    $ sudo gem install cocoapods

Create your Pod framework

  1. Open terminal and redirect to desired folder where you want to put your Pod Framework.
  2. Create your framework with the command pod lib create. Here I am giving my Pod framework name ‘MZFacebookManager’.
  • $ pod lib create MZFacebookManager
This will ask you some series of questions. You can answer based on your choice. Like for my case I have given answers like this:
  1. What language do you want to use? [ ObjC / Swift ]
     - ObjC
  2. Would you like to include a demo application with your library? [ Yes / No ]
     - Yes
  3. Which testing frameworks will you use? [ Specta / Kiwi / None ]
     - None
  4. Would you like to do view based testing? [ Yes / No ]
     - No
  5. What is your class prefix?
     - MZ

Once you are done it will create the folder for MZFacebookManager. Inside this you can see structure like:

Screen Shot 2017-04-06 at 1.19.25 PM

.podspec file at the root is important file. This will contains your Pod version, dependencies, git url etc with some other Pod descriptions. You can edit the details, version and also define dependencies if your Framework is using any other third party Framework. Like in my case, my Framework is using ‘FBSDKLoginKit‘ and ‘FBSDKCoreKit‘.

Screen Shot 2017-04-06 at 1.20.49 PM

Once you are done with editing of podspec file you need to validate this file. You can do this with Pod lib lint command.

$ pod lib lint

Screen Shot 2017-04-06 at 1.36.27 PM
Now open github website and create a new repository for MZFacebookManager (give your Framework name).

Screen Shot 2017-04-06 at 1.45.58 PMOnce it is created, go back to terminal again and push your code (You can also ignore this Push if you don’t want to push a default code on your git).

But if you want to push, just make sure once again your .podspec file is defined the correct url of git repository.

s.source = { :git => 'https://github.com/muzammil-triffort/MZFacebookManager.git', :tag => s.version.to_s }

Push your code on git: 

$ git push

This will push the default code of your Framework. Now open XCode again and add your Framework files.

  • Delete ReplaceMe file
  • Add your ObjC or Swift files (based on the project type you have chosen at the start)
  • Like i have added three files inside development i.e. MZFacebookManager.h, MZFacebookLoginManager.h and .m files. These files will show when you install the Pod Framework.

Screen Shot 2017-04-06 at 2.00.39 PM

Once all files added and there is no error in your code. Update the version of your Framework by updating this inside .podspec file (0.1.1) and run lib lint command again to make sure everything is correct.

$ pod lib lint

When validation success, now first push the code on git by giving a tag.

$ git tag 0.1.1

$ git push origin 0.1.1

Push your Pods Spec

$ pod trunk push MZFacebookManager.podspec 
At first time you will get the error message to resgister your session:
[!] You need to register a session first. 
$pod trunk register muzammil@triffort.com 'Muzammil' --description='Testing'

Replace my email id and name with yours. This will send a verification link on your mail. Once you verified, you can continue with terminal.

$ pod trunk push MZFacebookManager.podspec 
If all goes well Pod spec successfully update on git and you can see it is showing the description and other Pod details on home page of your git repository.
You can also add –verbose in lib lint and trunk push command to see the detail result (in case of error).
If you open your github repository, you can see screen like this:
Screen Shot 2017-04-06 at 2.22.10 PM
 Summary
# Create Library
pod lib create LibraryName
# Verify podspec
pod lib lint
# Push the podspec
pod trunk push LibraryName.podspec

Yeah! You are done with your first Pod Framework. It’s time to have some nice coffee. 

Still facing any issue with Pod? Or want to be in touch with us? Contact us:

Email:  muzammil@triffort.com Skype: muz.iphonedev

Triffort_logo

Triffort Technologies Pvt Ltd
www.triffort.com

How to install CocoaPods and setup with your Xcode project

Sometimes we are using many Git libraries inside our app. Like JSONKit, AFNetworking,  MBProgressHUD, EGOTableViewPullRefresh, Facebook-iOS-SDK etc. But it is very boring to build all libraries or if you add the code in your project, it is tough to manage. Also, there are many disadvantages in this:

  • Code that could be somewhere else is stored in your repository, wasting space.
  • Sometimes, it’s hard to get a specific version of a library.
  • There’s no central place where you can see which libraries are available.
  • Finding a new version of a library and updating your project with it is time taking and sometimes, painful.
  • Downloading libraries manually creates a tendency to perhaps make some changes to the downloaded code.
  • Updation is harder.

The most simplest solution is to use CocoaPods.

CocoaPods is the dependency manager for Objective-C and Swift projects. It has thousands of libraries and can help you scale your projects elegantly. CocoaPods is built with Ruby and is installable with the default Ruby available on OS X.

Installation:

Before installing Pods make sure you have installed/updated command line tool in your Mac machine. You can check this by opening Xcode, navigating the menu to Xcode > Preferences > Downloads > Components, finding Command Line Tools and select install/update.

command-line-tools

Also, make sure Git is installed in your Mac machine.

Open terminal and run this command:

sudo gem install cocoapods

Enter admin password. This could take a while. After few minutes it will show green message is cocoa pods installed successfully in your mac machine.

If you are getting any error with XCode like developer path is missing. First run this command in terminal: sudo xcode-select -switch /Applications/Xcode.app (or your XCodeName.app)

Hurrah….You successfully installed CocoaPods in your mac machine. Now you can setup Pod with your Xcode project.

How to setup POD for your Xcode project:

1. Open Terminal

2. Change directory to your XCode project root directory (where your ProjectName.xcodeproj file is placed).

3. $ pod setup : (Setting up CocoaPods master repo)

If successful, it shows : Setup completed (read-only access). So, you setup everything. Now Lets do something which is more visible…Yes ! Lets install libraries in your Xcode project.

Steps to add-remove-update libraries in pod:

1. Open Terminal

2. Change directory to your XCode project root directory. If your terminal is already running then no need to do this, as you are already at same path.

3. $ touch podfile

4. $ open -e podfile (This should open a blank text file or you can use: open -a Xcode podfile to open this inside Xcode)

5. Add your library names in that text file. You can add new names (lib name), remove any name or change the version. If you are using CocoaPods 1.0 or above you also have to have a ‘target’ section in your Pod File.

target '<Your Target Name>' 
do 
 pod 'AFNetworking', '~> 3.0' 
 pod 'FBSDKCoreKit'
 pod 'JSONKit'
 pod 'MBProgressHUD'
end

NOTE: Use ( control + ” ) button to add single quote at both end of library name. It should be shown as straight vertical line. Without control button it shall be added as curly single quote which will give error while installation of file.

6. Save and close this text file. Now libraries are setup and you have to install/update it.

7. Go to your terminal again and run this command: $ pod install (to install/update these libraries in pod).

You should see output similar to the following:

Updating spec repo `master’
Installing AFNetworking (3.0)…
Generating support files
After successful downloading/installation of any single library, It will generate ProjectName.xcworkspace in your project root directory. From now use this workspace to open your project. When you open your project work space you will see Pod is also added as another Xcode project with your Xcode project. If you open Pod it will show all libraries.

For your next project your don’t need to install the cocoa pod again in your mac machine just open the terminal and setup the Pod in root directory of your Xcode project and always remember these 3 commands :

  • 1. $ touch podfile
  • 2. $ open -e podfile
  • 3. $ pod install
To update Pod libraries : $ pod update
To check POD version : $ pod --version
To update CocoaPods : $ gem install cocoapods 

or use sudo at start if getting error "You don't have write permissions for the /Library/Ruby/Gems/2.0.0 directory."

How to use Pod with Swift? Follow This.

Still facing any issue with Pod? Or want to be in touch with us? Contact us:

Email:  muzammil@triffort.com Skype: muz.iphonedev

Triffort_logo

Triffort Technologies Pvt Ltd
www.triffort.com