CocoaPods

CocoaPods

UITableView + API GitHub + CocoaPods = Keep it Simple, keep it Stupid!

UITableView + API GitHub + CocoaPods = Keep it Simple, keep it Stupid!

Nous avons vu dans un article précédent comment utiliser RestKit pour se faciliter la vie lorsque nous travaillons avec des services web exploitant le format JSON. Toutefois, l’utilisation d’un framework fullstack peut se révéler contraignant dès lors que l’on sort du cadre pour lequel il a été destiné. Malheureusement, cela arrive souvent assez rapidement.

Nous verrons dans cet article comment reproduire une application similaire à celle construite grâce à RestKit, sans pour autant abandonner l’idée de gagner du temps grâce à l’utilisation de quelques librairies bien choisies :

Le monde iOS, comme tout environnement mature, dispose de nombreuses librairies Open Source intégrables dans vos projets via l’utilisation d’un Dependency Manager. Dans notre cas, nous utiliserons CocoaPods déjà présenté dans un article précédent.

La création de ce tutoriel fait suite à une présentation en XKE d’une session d’1h30 d’introduction aux développements iOS. Ce tutoriel est donc réalisable en un temps raisonnable en suivant les instructions ci-dessous.

Création du projet

Avant d’utiliser CocoaPods, vous devrez créer un projet de type Empty Application pour iOS via XCode:

Vous aurez ensuite à créer un fichier Podfile à la racine de votre projet XCode avec les dépendances suivantes:

platform :ios, '5.0'
pod 'JSONKit', '1.5pre'
pod 'Underscore.m', '0.2.0'
pod 'AFNetworking', '1.1'
pod 'MBProgressHUD', '0.6'
pod 'SVPullToRefresh', '0.4'
pod 'SDURLCache', '1.2'
pod 'AFHTTPRequestOperationLogger', '0.10.0'
pod 'DCKeyValueObjectMapping', '1.3'

Puis, vous devrez exécuter la commande suivante pour générer le workspace et intégrer le code des dépendances:

pod install

Il faudra alors relancer votre projet en ouvrant le fichier *.XCodeWorkspace, plutôt que le fichier *.XCodeProject. Vous serez alors prêt à développer votre application.

(suite…)

Gérez vos dépendances Objective-C avec CocoaPods

Gérez vos dépendances Objective-C avec CocoaPods

La popularité du langage Objective-C est en constante augmentation ces dernières années. Les succès de l’iPhone et de l’iPad en sont à coup sûr une raison évidente. L’Objective-C, cependant, est utilisé depuis bien plus longtemps dans le développement des logiciels Apple. Le langage en lui-même a été inventé en 1983 comme indiqué sur sa page Wikipedia. Apple prend d’ailleurs un soin particulier à faire évoluer son langage en y apportant de nouveaux raffinements chaque année (Spécification Objective-C 2.0, …).

Bien qu’Apple propose une tool chain à la pointe basée sur LLVM et Clang, il faut se rendre à l’évidence: la gestion des dépendances en Objective-C reste un domaine assez peu exploré, et laisse un petit goût amer lorsqu’on a goûté à d’autres langages accompagnés de leur gestionnaires de dépendances. Je pense ici à JavaScript avec Node.JS et NPM, Ruby et ses Gem, ou bien encore notre bon vieux Java et autres languages de la JVM qui fournissent eux aussi une multitude d’outils répondant à ce besoin.

Il semble que les langages des générations C / C++ et Objective-C aient plus de mal à fournir des outils de ce type. L’intégration de librairies et frameworks peut d’ailleurs rapidement donner des maux de têtes aux développeurs, ce qui n’est pas acceptable pour un langage / écosystème de développement qui se veut moderne.

Concernant l’Objective-C, la réponse à l’absence de gestionnaire de dépendance est venue de la communauté à travers la création d’un outil appelé: CocoaPods. Cet outil est basé sur le partage de configurations également nommées Spec. Elles ont pour rôle de décrire le contenu d’une dépendance. L’outil, développé en Ruby, est visiblement assez inspiré de l’éco-système qui existe autour de ce langage.

Installation & Utilisation

Pour installer CocoaPods, vous devez exécuter les commandes suivantes:

$ [sudo] gem install cocoapods
$ pod setup

Un des points très intéressant de cet outil est sa simplicité d’utilisation : il suffit en effet de créer un fichier « Podfile » à la racine de son projet XCode listant les dépendances requises et de lancer la commande:

pod install

pour que l’outil aille télécharger tous les fichiers sources nécessaires sur internet et vous configure un workspace XCode en bonne et due forme sans effort supplémentaire de votre part. Pour ouvrir le workspace XCode configuré avec toutes ses dépendances, il suffit d’exécuter ensuite la commande :

open my-project.xcworkspace

Les pré-requis à l’utilisation de CocoaPods se résument à installer Ruby 1.9 sur sa machine (si ce n’est déjà fait).

Note : Si vous avez exécuté l’installation avec une version de Ruby 1.8, je vous conseille de nettoyer votre dossier .gem dans votre dossier home, et de recommencer l’installation pour éviter tout problème de compatibilité.

Configuration

L’outil est utilisable aussi bien pour des projets iOS que pour des projet OS X. Pour cela, il suffit de spécifier la cible en début de fichier comme indiqué dans l’exemple ci-dessous :

platform :ios

pod 'JSONKit', '1.5pre'
pod 'LibComponentLogging-Core', '1.2.2'
pod 'LibComponentLogging-NSLog', '1.0.4'
pod 'Reachability', '3.0.0'
pod 'RestKit', '0.10.1'

Contrairement à ce que laisse penser l’exemple précédent, différents opérateurs de comparaison permettent d’affiner les versions des librairies utilisées. Il est possible de créer des configurations plus complexes si votre projet le requiert en allant visiter la documentation du projet. Vous pouvez, entre autre chose, créer plusieurs target correspondant, par exemple, à des targets de test ou de debug de vos applications.

Spécifications

Cerise sur le gâteau, le système de contribution d’une dépendance est très simple, puisque vous pouvez, vous-même, constituer une spécification de dépendances et la soumettre via un Pull Request sur le repository Github CocoaPods/Specs. Ce repository contient l’ensemble des spécifications de dépendances utilisables avec CocoaPods. La lecture de différents fichiers Spec, en plus de la lecture du wiki du projet, permet de comprendre très rapidement le format.

Exemple de spécification pour la librairie Cordova 2.1.0 (PhoneGap) :

Pod::Spec.new do |s|
s.name = "Cordova"
s.version = "2.1.0"
s.summary = "Apache Cordova is a platform for building native mobile applications using HTML, CSS and JavaScript."
s.homepage = "http://incubator.apache.org/cordova/"
s.author = "Original developed by Nitobi (acquire by Adobe) and all other PhoneGap and Cordova Contributors"

s.license = 'Apache License, Version 2.0'

s.source = { :git => "http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios.git", :tag => "2.1.0" }
# s.source = { :git => "https://github.com/apache/incubator-cordova-ios.git", :tag => "2.1.0" }
s.source_files = 'CordovaLib/Classes/*.{h,m}'
s.resources = 'CordovaLib/javascript/*.js', 'CordovaLib/VERSION'

s.platform = :ios, '4.3'
s.requires_arc = true

# TODO: Missing AddressBookUI here, but CocoaPods generates incorrect OTHER_LDFLAGS in Pods/Pods.xcconfig. Will analyse this soon..
# OTHER_LDFLAGS = -ObjC UI -framework AVFoundation < - incorrect UI argument here!

s.frameworks = 'AddressBook', 'AudioToolbox', 'AVFoundation', 'CoreLocation', 'MediaPlayer', 'QuartzCore', 'SystemConfiguration', 'MobileCoreServices', 'CoreMedia', 'UIKit'

# Note: This is not the same like the original JSONKit. Cordova developers decide to integrate
# *a changed copy* (with prefixed class and method names) of it instead of using CocoaPods. :S
# But they missed to translate it like the main project to use ARC, yet.
s.subspec 'JSON' do |json|
json.source_files = 'CordovaLib/Classes/JSON/*.{h,m}'
json.platform = :ios, '4.3'
json.requires_arc = false
# TODO requires_arc does not work for subproject, so set compiler flag by hand until CocoaPods 0.15(?) will support this.
json.compiler_flags = '-fno-objc-arc'
end

end

Moteur de recherche

Bien entendu, il ne serait pas possible de tirer toute la quintessence d’un tel outil sans un moteur de recherche de dépendances associé, c’est ce que propose le site CocoaPods.org.

Les fans de la ligne de commande pourront bien entendu lister les dépendances disponibles via la commande :

pod list

ou bien encore trouver la liste des autres commandes disponibles via l’aide :

pod help

Conclusion

Doucement mais sûrement, un éco-système composé d’outils modernes d’aide au développement s’est formé autour d’Objective-C, et CocoaPods en est un rouages important. Parmi ces nouveaux outils, nous pouvons en citer quelques uns: :

  • ios-boilerplate.com est un kickstarter pour démarrer une application iOS.  Ce template permet de gagner un temps précieux au bootstrap du projet, et fait inévitablement penser au désormais célèbre html5-boilerplate.
  • cocoacontrol.com est un site web référençant nombre de composants utilisables dans vos projet iOS.
  • iosframeworks.com est un catalogue référençant classes et frameworks utiles pour vos projets.