Merge with latest build and Pull Request

Ήρθε η ώρα να στείλουμε τις αλλαγές μας στον αρχικό project. Έτσι αρχικά τραβήξαμε από το github το τελευταίο build του original project, κάναμε κάποιες αλλαγές που χρειάστηκαν και τελικά στείλαμε το pull request! :) Now we wait

Ενδεικτικά χρειάστηκε πχ να αλλάξουμε των κώδικα που εμφανίζει το link για το Rails Admin Panel που προσθέσαμε καθώς πλέον το engine του Rails Admin φορτώνεται μόνο στο production environment.

Correlations Admin View

Όπως βλέπουμε και στην εικόνα η εμφάνιση των στατιστικών στοιχείων ήταν αρκετά άσχημη χωρίς καμία μορφοποίηση.

Έτσι λοιπόν αρχικά χρησιμοποιήσαμε string manipulation της Ruby έτσι ώστε να επεξεργαζόμαστε το string όνομα της μεταβλητής και να το εμφανίζουμε μορφοποιημένο (line 15):

Έπειτα οργανώσαμε το output σε έναν ωραίο πίνακα ώστε να εμφανίζονται πιο οργανωμένα. (above - lines 9-16) (μπορείτε να βρείτε το css εδώ: http://pastebin.com/kpN9Vsk8)

To αποτέλεσμα λοιπόν είναι το εξής:

Rails Admin Added

Προστέθηκε σύνδεσμος στο Administration Panel ο οποίος σε οδηγεί στην οθόνη για το administration του site. (Αφορά κυρίως διαχείριση των στοιχείων της βάσης δεδομένων)

Revamped Admin's User Search

Πριν:

Η λειτουργία που έδινε τη δυνατότητα στον admin να ψάξει τους εγγεγραμμένους χρήστες και να δει αναλυτικά τα στοιχεία τους χρειαζόταν αρκετή διαμόρφωση. Αρχικά για να βρεις ένα χρήστη έπρεπε να ξέρεις ακριβώς το username του ή το email του. Δεν μπορούσες να γράψεις μέρος του username του. Επίσης τα αποτελέσματα εμφανιζόντουσαν σε raw μορφή δηλαδή έτσι όπως ακριβώς τα διάβαζε η rails χωρίς καμία απολύτως μορφοποίηση. Αυτό τα καθιστούσε τραγικά δύσκολο να διαβαστούν. Αυτά φαίνονται και στις παρακάτω εικόνες

Μετά:

Όπως βλέπουμε στις παρακάτω εικόνες πλέον μπορούμε να κάνουμε full text search οπότε δεν χρειάζεται να ξέρουμε ακριβώς το username/email για να βρούμε ένα χρήστη. Επίσης τα αποτελέσματα οργανώθηκαν σε expandable lists. Ακόμα η εμφάνιση δεν είναι τέλεια αλλά νομίζω είναι πολύ καλύτερα από πριν!

Κώδικας:

Αρχικά όσον αφορά την αναζήτηση η μέθοδος user_search στον adminController διαμορφώθηκε ως εξής (Χρησιμοποιώντας την δυνατότητα της mySQL βάσης για full text search μέσω της εντολής LIKE):

Μετά φτιάχτηκε ένα partial view στο οποίο περνάμε το collection @users που επιστρέφει η μέθοδος και, μας δημιουργεί τη λίστα.

το css και το javascript τα οποία δίνουν τη δυνατότητα στη λίστα να είναι expandable είναι τα εξής:

Seed Admin Rake Task

Αποφασίσαμε λοιπόν να ασχοληθούμε με το admin panel επομένως έπρεπε πρώτα να φτιάξουμε έναν admin χρήστη ώστε να έχουμε πρόσβαση στον πάνελ. Παρατήρησα λοιπόν ότι δεν υπάρχει κάποια διαδικασία δημιουργίας του admin χρήστη. Πρέπει χειροκίνητα να φτιάξεις ένα χρήστη στη βάση δεδομένων και έπειτα να φανταστείς ότι πρέπει να φτιάξεις εγγραφή στον πίνακα roles και ώς name της εγγραφής να βάλεις admin...
Έτσι λοιπόν αποφάσισα να φτιάξω ένα rake task το οποίο διαβάζει από τον φάκελο config ένα αρχείο admin.yml και δημιουργεί τους χρήστες που βρίσκει εκεί μέσα και έπειτα τους δίνει administrative rights.
Για παράδειγμα μπορούμε να δημιουργήσουμε 2 administrators γράφοντας στο admin.yml τα εξής:


admin1:
  name: "Kostas Stavrou"
  username: "kostas4"
  password: "123456"


admin2:
  name: "Thomas Asikis"
  username: "thomas4"
  password: "123456"

και έπειτα τρέχοντας την εντολή "rake admin"

Print Screen από terminal:

Ο κώδικας που εκτελείται είναι ο εξής:

Μετά από επικοινωνία με τους developers παρατηρήσαμε ότι έχει αναλάβει άλλος ήδη την εφαρμογή AJAX και σχεδόν έχει ολοκληρωθεί επομένως δεν μπορέσαμε να βοηθήσουμε. Όμως μας έδωσαν διαφορετικές κατευθύνσεις ώστε να μπορέσουμε να συνεισφέρουμε πιο αποδοτικά. Συγκεκριμένα μας είπαν να δώσουμε έμφαση στον administration panel

AJAX with Bookmarks and History

Αποφασίσαμε να προχωρήσουμε ένα βήμα παραπέρα από το απλό full-AJAX implementation και να συμπεριλάβουμε bookmarking και history. Βάζοντας απλά AJAX δεν θα έκανε refresh η σελίδα αλλά θα άλλαζαν μόνο συγκεκριμένα κομμάτια. Επομένως αν ο χρήστης θέλει να κάνει bookmark κάποιο σημείο της ιστοσελίδας (π.χ. το προφίλ ενός φίλου του) δεν θα μπορούσε. Επίσης δεν θα μπορούσε να πατήσει το πλήκτρο back και να μεταφερθεί σε μια προηγούμενη "κατάσταση" της ιστοσελίδας. Όμοια δεν θα αποθηκεύεται και στο ιστορικό η "πλοήγηση" του μέσα στην ιστοσελίδα. Επομένως θεωρούμε ότι είναι σημαντικό να υπάρχει τέτοια δυνατότητα και όχι απλό full-ajax implementation καθώς θα μειώσει το user experience αντί να το αυξήσει και αυτός είναι ο στόχος μας. Για να το πετύχουμε αυτό θα χρησιμοποιήσουμε τη βιβλιοθήκη jQuery-BBQ η οποία προφανώς στηρίζεται στην jQuery.

Model Dependency Diagram

Αυτό είναι το διάγραμμα των μοντέλων του project, δηλαδή των αντικειμένων. Δεν περιέχει τους controllers οι οποίοι κάνουν λειτουργίες πάνω στα αντικείμενα.Για να το δείτε σε μεγαλύτερη ανάλυση μπορείτε να το κατεβάσετε από εδώ!

Up And Running

Επιτέλους κατάφερα να ρυθμίσω το laptop μου να τρέχει το website του Diaspora. Ακόμα καλύτερα θα ήταν να ρυθμίσω πλήρως το site να τρέχει μέσω του Thin application server πάνω σε έναν Nginx web server όμως δεν χρειάζεται αυτό σε development mode παρά μόνο σε production mode όπου η ταχύτητα και η απόδοση μας ενδιαφέρει.

Τώρα που όλα είναι έτοιμα αρχίζει το πιο δύσκολο κομμάτι. Let the coding begin!

Some Statistics

Όσον αφορά το μέγεθος του έργου το RoR (Ruby on Rails) framework μας δίνει ένα έτοιμο εργαλείο το οποίο ονομάζεται rake stats. Λόγω των ρυθμίσεων που έχουν γίνει στον κώδικα από τους developers το εργαλείο δεν έτρεχε επομένως χρειάστηκε λίγο επεξεργασία πρώτα από θέμα κώδικα... το output λοιπόν είναι το παρακάτω

+----------------------+-------+-------+---------+---------+-----+-------+

| Name | Lines | LOC | Classes | Methods | M/C | LOC/M |

+----------------------+-------+-------+---------+---------+-----+-------+

| Controllers | 2607 | 2031 | 36 | 179 | 4 | 9 |

| Helpers | 921 | 740 | 0 | 98 | 0 | 5 |

| Models | 4531 | 3364 | 82 | 450 | 5 | 5 |

| Libraries | 4030| 2806 | 53 | 451 | 8 | 4 |

| Views | 446 | 385 | 0 | 0 | 0 | 0 |

| Static HTML | 433 | 342 | 0 | 0 | 0 | 0 |

| Static CSS | 9554 | 9160 | 0 | 0 | 0 | 0 |

+----------------------+-------+-------+---------+---------+-----+-------+

| Total | 22522 | 18828 | 171 | 1178 | 6 | 13 |

+----------------------+-------+-------+---------+---------+-----+-------+

Code LOC: 18828 Test LOC: 0 Code to Test Ratio: 1:0.0

Diaspora Project

Δεν χρειάστηκε να ψάξουμε και πάρα πολύ να βρούμε ένα καλό open source project καθώς μόλις πέσαμε πάνω στο diaspora ξέραμε ότι έχουμε βρει το ιδανικότερο project για να ασχοληθούμε. Ποιος άλλωστε δεν θα ενδιαφερόταν για το πρώτο open source κοινωνικό δίκτυο. Και μάλιστα ένα δίκτυο το οποίο σου δίνει την δυνατότητα να είσαι ο μοναδικός κύριος των προσωπικών σου στοιχείων και να μην χρειάζεται να τα "θυσιάσεις" με αντάλλαγμα την δυνατότητα να χρησιμοποιήσεις το site.

Όσον αφορά την συνεισφορά μας στο project υπάρχουν πολλές επιλογές. Το project αυτή τη στιγμή βρίσκεται σε alpha phase το οποίο σημαίνει ότι υπάρχουν πολλά bugs καθώς και out-of-date gems που χρειάζονται διόρθωση, καθώς και πολλές ακόμα βελτιώσεις όσον αφορά τη λειτουργικότητα!

Επίσης στόχος μας είναι να στήσουμε ένα pod στο πανεπιστήμιο μας ώστε να έχουμε το δικό μας κοινωνικό δίκτυο (όπου τα προσωπικά δεδομένα θα είναι αποθηκευμένα σε server του πανεπιστημίου) και μέσω του diaspora network θα είναι συνδεδεμένο με όλο τον υπόλοιπο κόσμο! Περιμένουμε και το δικό σας feedback σχετικά με την ιδέα και αν θα σας ενδιέφερε!

Φιλικά,

Θωμάς Ασίκης και Κωνσταντίνος Σταύρου