Lanalisi e le scelte nello sviluppo di un plugin

L'analisi e le scelte nello sviluppo di un pluginScelta degli strumenti e delle metodologie per migliorare i tempi e la qualità del software. Conoscere le potenzialità che TYPO3 ci offre sia con le modalità di sviluppo classico (tslib_pibase), sia con lo sviluppo MVC (ExtBase).

Federico Bernardin <[email protected]>

T3Camp ItaliaL’evento italiano dedicato a

Bologna 27/28 Ottobre 2011

mailto:[email protected]

mailto:[email protected]


FLOW3Federico Bernardin

About me

About me

Mi occupo di progettazione e dello sviluppo di siti web con TYPO3 dal 2004, ho all’attivo alcuni plugin, tra cui xflextemplate, da Aprile 2010 sono TYPO3 Certified Integrator.

Sono libero professionista e mi occupo di consulenza informatica.

In particolare seguo i progetti web per l’agenzia Pallino & Co. di Padova, dove coordino il team di sviluppatori su



Obiettivi



Obiettivi

Possibilità di riportarmi ad una versione precedente alle ultime modifiche.



Obiettivi


Possibilità di lavoro in team, dove più persone modificano lo stesso file (non le stesse righe).



Obiettivi



Comodità nella scrittura del codice, aiuto nella scrittura delle funzioni.



Obiettivi




Sistemi di controllo della sintassi.



Obiettivi




Sistemi di controllo della sintassi.

Integrazione con FTP o gestione di cartelle remote.



Obiettivi



Obiettivi

Processo di controllo della pubblicazione e dello sviluppo mediante task control, features e milestone.



Obiettivi


Aiuto nell'analisi del plugin.



Obiettivi



Sistemi di refactoring.



Obiettivi




Sistemi di test e controllo.



Obiettivi




Sistemi di test e controllo.

Utilizzo delle funzioni integrate in TYPO3.



Analisi e briefing



Analisi e briefing

La prima operazione e forse la più complessa e delicata è la raccolta delle informazioni per sviluppare un’estensione effettivamente attinente alle richieste del cliente.



Analisi e briefing

La prima operazione e forse la più complessa e delicata è la raccolta delle informazioni per sviluppare un’estensione effettivamente attinente alle richieste del cliente.

Errori in questa fase si ripercuotono poi in maniera altamente traumatica sulla fase di sviluppo, richiedendo a volte la necessità di un refactoring dell’applicazione.



Strumenti



Strumenti

IDE (Integrated Development Environment) è l’applicazione con cui lavoriamo principalmente durante lo sviluppo e che ci deve fornite tutte le funzioni di cui abbiamo bisogno durante la scrittura del codice.



Strumenti


Sistema di versioning. Questa applicazione ci deve dare tutte le funzioni per poter gestire il versionamento del codice, soprattutto in una modalità multi utente.



Strumenti


Sistema di versioning. Questa applicazione ci deve dare tutte le funzioni per poter gestire il versionamento del codice, soprattutto in una modalità multi utente.

Sistema di gestione del processo con task, bugs, features, con integrazione del processo di versionamento e pubblicazioni delle modifiche.



Strumenti



Strumenti

Sistema di test e controlli, per poter ridurre il carico di lavoro in caso di modifiche al codice.



Strumenti

Sistema di test e controlli, per poter ridurre il carico di lavoro in caso di modifiche al codice.

Sistema di pubblicazione mediante protocollo FTP dell’applicazione su server remoti.



Subversion definizione e vantaggi




Subversion è un’applicazione server per la gestione multi utente del versionamento.





SVN garantisce la possibilità di riportarsi ad una qualsiasi versione salvata precedentemente o confrontare due revisioni.






SVN garantisce la possibilità di effettuare la fusione (merge) del codice, magari sviluppato da persone diverse.






SVN garantisce la possibilità di effettuare la fusione (merge) del codice, magari sviluppato da persone diverse.

SVN permette di creare delle patch che permettono l’aggiornamento del codice da una revisione a quella attuale.



SVN: un esempio



Eclipse-Aptana definizione e vantaggi




Eclipse è uno strumento inizialmente sviluppato da IBM per JAVA. Oggi è un IDE ottimizzato per l’uso di svariati linguaggi, come ad esempio PHP.





Aptana è un plugin di Eclipse che permette di utilizzare FTP, e di avere un editor PHP integrato con SVN e Mylyn plugin.






Aptana e il suo editor PHP (PDT) permettono la gestione del template e dell’autocomplete, rendendo meno gravoso la scrittura del codice da parte dell’utente.






Aptana e il suo editor PHP (PDT) permettono la gestione del template e dell’autocomplete, rendendo meno gravoso la scrittura del codice da parte dell’utente.

Aptana (Eclipse) possiede moltissimi plugin che estendono le funzionalità base come ad esempio il debugger e la gestione del refactoring.



Eclipse-Aptana: diamogli un occhio



TYPO3 Forge definizione e vantaggi




Forge raggiungibile all’indirizzo http://forge.typo3.org è un servizio che l’associazione mette a disposizione per poter avere un ambiente dove sviluppare e mantenere le proprie estensioni pubbliche.

https://forge.typo3.org






Forge si basa su Redmine un application project framework per la gestione dei progetti scritto in ruby on rails.








Automaticamente viene creato un’ambiente pronto per mantenere le nostre estensioni con un repository svn compreso.









E’ possibile gestire nuove richieste per bug fixing, features e task.









E’ possibile gestire nuove richieste per bug fixing, features e task.

Il sistema si integra perfettamente con Eclipse potendo recuperare la lista delle segnalazioni da remoto tramite il plugin Mylyn.





TYPO3 Forge



TYPO3 come framework




TYPO3 non è solo un CMS ma bensì un framework, fornendo una serie di librerie che aiutano a gestire le varie funzionalità, senza la necessità di scrivere ridondanti funzioni.





L’estensione extdeveval, permette di aggiungere nella barra superiore di TYPO3 un’icona che permette di vedere le varie classi e funzioni che TYPO3 mette a disposizione per gli sviluppatori





L’estensione extdeveval, permette di aggiungere nella barra superiore di TYPO3 un’icona che permette di vedere le varie classi e funzioni che TYPO3 mette a disposizione per gli sviluppatori

Un’alternativa è andare ad api.typo3.org, dove potete trovare la lista completa delle funzioni all’interno del sistema.



I test



I test

Una delle parti più complesse e importanti dello sviluppo di un plugin sono i test.



I test


In genere in PHP esiste PHP Unit Test che fornisce una serie di librerie per poter effettuare dei test sul software realizzato.



I test



L’estensione PHP Unit (<phpunit>) di TYPO3 ci da la possibilità di testare e verificare i nostri test case.



I test



L’estensione PHP Unit (<phpunit>) di TYPO3 ci da la possibilità di testare e verificare i nostri test case.

I test diventano importanti nei casi in cui un piccolo refactor potrebbe modificare il comportamento del codice, riducendo fortemente i tempi di test.



Scelta del paradigma




In TYPO3 abbiamo due soluzioni fondamentali (incorporate direttamente del sistema) per sviluppare il nostro plugin.





Effettuando l’extend della classe tslib_pibase possiamo sviluppare un plugin con il paradigma OOP (Object Oriented Programming). Questa classe ci fornisce una serie di funzionalità base utili per implementare la nostra estensione.






Un’alternativa più nuova è sicuramente l’utilizzo di un paradigma MVC (model view controller). L’associazione ha creato un’estensione (<extbase>) che permette di utilizzare il paradigma MVC dentro la nostra estensione.






Un’alternativa più nuova è sicuramente l’utilizzo di un paradigma MVC (model view controller). L’associazione ha creato un’estensione (<extbase>) che permette di utilizzare il paradigma MVC dentro la nostra estensione.

Extbase è nata per permettere di creare applicazioni MVC FLOW3-compatibili.



Documentazione



Documentazione

Lo sviluppo di un’estensione deve essere sempre accompagnata da documentazione che descrive il funzionamento tecnico del codice e soprattutto di documentazione di utilizzo.



Documentazione


Tramite il sito typo3.org è possibile scaricare l’estensione (<doc_template>) che contiene il manuale che dovrebbe essere poi usato per scrivere la documentazione di utilizzo della nostra estensione.



Documentazione



Un’estensione senza manuale è un’estensione inutile e nel futuro potrebbero essere eliminate le estensioni senza manuale d’uso.



Documentazione



Un’estensione senza manuale è un’estensione inutile e nel futuro potrebbero essere eliminate le estensioni senza manuale d’uso.

Il manuale dovrebbe essere scritto, anche in minima parte, ancor prima di scrivere il codice



Alcuni consigli



Alcuni consigli

Fare un’analisi molto dettagliata, non lasciando troppe incognite che richiedano poi un rifacimento dell’analisi.



Alcuni consigli


Stabilire sulla base dell’applicazione il paradigma da usare: OOP come tslib_pibase oppure MVC con extbase, valutando attentamente i pro e i contro.



Alcuni consigli



Cercare sempre sul TER se esistono estensioni già sviluppate ed affidabili che possano essere usate estendendole così da evitare di scrivere codice.



Alcuni consigli




Creare il codice in modo che possano essere usate le unit test per effettuare i test dell’applicazione.



Alcuni consigli




Creare il codice in modo che possano essere usate le unit test per effettuare i test dell’applicazione.

Inserire i commenti javadoc per essere poi usati da applicazioni di analisi dei commenti.



Buon sviluppo a tuttisia in OOP che in MVC!!

Lanalisi e le scelte nello sviluppo di un plugin

Technology

Transcript of Lanalisi e le scelte nello sviluppo di un plugin