Kmom05: Modul på Packagist

By . Latest revision .

** Kursutveckling pågår till kurs ramverk v2 **

Kursstart hösten 2018.

Du skall skapa en fristående modul av ditt kommentarssystem och placera det i ett eget repo på GitHub. Du skall alltså lyfta bort koden från din me-sida och placera allt som modulen behöver i ett eget repo.

Du skall sedan publicera repot som en PHP modul på Packagist. När det är klart kan du åter installera modulen i din me-sida med hjälp av kommandot composer.

Du börjar införa enhetstestning på din modul.

När du är klar så har du alltså samma kodbas som från början. Men du har brutit loss en självständig del från din me-sida och gjort den till en egen fristående modul. Vi vinner förhoppningsvis en bättre kodstruktur som gör det enklare att jobba med vidareutveckling, underhåll och test.

Så här ser det ut när vi submittar paketet till Packagist.

Submitta ett paket till Packagist genom att ange dess url till GitHub.

Submitta ett paket till Packagist genom att ange dess url till GitHub.

Nu är paketet på plats på Packagist.

Nu är paketet på plats på Packagist.

(Detta är instruktionen för kursmomentet och omfattar det som skall göras inom ramen för kursmomentet. Momentet omfattar cirka 20 studietimmar inklusive läsning, arbete med övningar och uppgifter, felsökning, problemlösning, redovisning och eftertanke. Läs igenom hela kursmomentet innan du börjar jobba. Om möjligt – planera och prioritera var du vill lägga tiden.)

#Läsanvisningar

(ca: 2-4 studietimmar)

#Artiklar

Kika igenom följande artiklar.

  1. Artikeln PHP The Right Way innehåller ett kort stycke om “Dependency Management”, läs igenom det som en introduktion.

  2. Läs om begreppet “Sematic versioning” som berättar hur du bör hantera versionsnummer på dina programvara.

  3. Bekanta dig med webbplatsen “Packagist” och skaffa dig ett konto på webbplatsen.

  4. Det skadar inte att färska upp minnet om “dokumentationen för composer” vilket kan komma till användning när du skall publicera din modul till Packagist.

#Övningar & Uppgifter

(ca: 12-16 studietimmar)

#Övningar

Gör följande övningar, de behövs normalt för att klara uppgifterna.

  1. Jobba igenom artikeln “Skapa en PHP-modul på Packagist och integrera med Anax” som visar dig hur du skapar en egen PHP-modul som du kan installera med kommandot composer. Du sparar koden i me/kmom05/anax5.

#Uppgifter

Följande uppgifter skall utföras och resultatet skall redovisas via me-sidan.

  1. Utför uppgiften “Skapa en PHP-modul och publicera på GitHub och Packagist”. Du kan spara källkoden till din modul i me/comment.

  2. Gör uppgiften “Integrera me-sidan med egen kommentarsmodul från Packagist”. Du får använda den modulen som du nyligen publicerat på Packagist och installera den med composer i din me-sida. Koden uppdaterar du i me/anax.

  3. Pusha och tagga ditt Anax, allt eftersom och sätt en avslutande tagg (5.0.*) när du är klar med alla uppgifter i kursmomentet.

#Resultat & Redovisning

(ca: 2-4 studietimmar)

Läs instruktionen om hur du skall redovisa.

Se till att följande frågor besvaras i texten:

  • Hur gick arbetet med att lyfta ut koden ur me-sidan och placera i en egen modul?
  • Flöt det på bra med GitHub och kopplingen till Packagist?
  • Hur gick det att åter installera modulen i din me-sida med composer, kunde du följa du din installationsmanual?
  • Hur väl lyckas du enhetstesta din modul och hur mycket kodtäckning fick du med?
  • Några reflektioner över skillnaden med och utan modul?

Har du frågor eller funderingar så ställer du dem i forumet.

#Revision history

  • 2018-06-08: (prel, mos) Nytt dokument inför uppdatering av kursen.
  • 2017-09-11: (A, mos) Preliminär release, artikel saknas.

Document source.