Apa Bedanya Adobe Illustrator Dengan Photoshop?

Pada suatu hari, saya meminta mahasiswa untuk merancang gambar yang dipakai pada pemograman game. Saya menyarankan mereka untuk menggunakan Adobe Illustrator. Seorang mahasiswa pencinta Photoshop kontan protes dan segera membela tool kesayangannya. Mengapa memakai Illustrator? Berbeda dengan Photoshop, Illustrator menyimpan data dalam bentuk vector sehingga scalable. Bila pengguna Photoshop cenderung menggunakan brush untuk mempoles gambar, maka pengguna Illustrator lebih sering memanipulasi bentuk (shape dan anchor point). Hal ini membuat Illustrator sangat nyaman dipakai untuk merancang gambar seperti kartun dan icon.

Pada Illustrator, terdapat 2 tool pemilihan utama yang sering digunakan, yaitu Selection Tool (V) dan Direct Selection Tool (A) seperti yang terlihat pada gambar berikut ini:

Selection dan Direct Selection Tool

Selection dan Direct Selection Tool

Dengan Direct Selection Tool, saya bisa memilih setiap titik (disebut sebagai anchor point) pada sebuah bentuk. Dengan demikian, saya bisa memanipulasi setiap anchor point yang ada. Sebagai contoh, saya bisa mengubah sebuah persegi panjang menjadi trapesium:

Memodifikasi anchor point

Memodifikasi anchor point

Saya juga bisa melakukan hal di atas dengan Photoshop! Untuk menghapus atau menambah anchor point di Photoshop, saya dapat memilih tool yang terletak di kotak yang sama dengan Pen Tool (P). Selain itu, Direct Selection Tool (A) di Photoshop tersembunyi karena terdapat di kotak yang sama dengan Path Selection Tool (A).

Illustrator memiliki menu khusus untuk memanipulasi path yang dapat diakses di Object, Path. Sebagai contoh, tidak ada cara cepat untuk membuat shape segitiga di versi Photoshop yang saya pakai. Sebaliknya, membuat segitiga sangat mudah di Illustrator. Saya mulai dengan membuat sebuah persegi panjang dan memilih anchor point di sudut kiri atas dan kanan atas. Setelah itu, seusai memakai menu Object, Path, Average…, saya akan memperoleh sebuah segitiga seperti pada gambar berikut ini:

Membuat segitiga

Membuat segitiga

Sama seperti di Photoshop, saya juga dapat mengatur stroke dan mengisi sebuah bentuk dengan gradien di Illustrator. Sebagai contoh, saya akan menghapus stroke dan mengisi bentuk trapesium yang saya buat dengan gradien seperti pada gambar berikut ini:

Mengisi trapesium dengan gradien

Mengisi trapesium dengan gradien

Satu hal yang tidak bisa saya lakukan di Photoshop secara cepat adalah menghaluskan ujung (rounding) pada trapesium ini. Photoshop memang menyediakan pengaturan penghalusan ujung untuk persegi panjang, tapi setelah dimodifikasi menjadi trapesium, saya tidak menemukan pengaturan tersebut lagi. Di Illustrator, saya dapat melakukan hal ini cukup dengan memilih menu Effect, Stylize, Round Corners… seperti pada gambar berikut ini:

Menghaluskan ujung trapesium

Menghaluskan ujung trapesium

Saya kemudian membuat dua trapesium lain di samping kiri dan kanan sehingga gambar saya terlihat seperti pada gambar berikut ini:

Membuat trapesium baru di sisi kiri dan kanan

Membuat trapesium baru di sisi kiri dan kanan

Sekarang, saya ingin sebuah trapesium di bagian bawah untuk melengkapi bagian yang kosong. Pada Photoshop, saya harus menggambarnya secara manual. Illustrator menawarkan cara lain melalui penggunaan Shape Builder Tool (Shift+M). Dengan Shape Builder Tool, saya bisa menggabungkan atau menghapus (dengan menahan tombol Alt) bagian kombinasi dari beberapa shape. Sebagai contoh, saya membuat sebuah persegi panjang dan meletakkannya di belakang (dengan memilih Object, Arrange, Send To Back) seperti pada gambar berikut ini:

Menambahkan sebuah persegi panjang

Menambahkan sebuah persegi panjang

Setelah itu, saya memilih seluruh shape yang ada, kemudian membuang bagian yang tidak dibutuhkan dengan menggunakan Shape Builder Tool:

Memakai shape builder tool

Memakai shape builder tool

Setiap shape di Illustrator bisa memiliki lebih dari satu fill atau stroke dengan effect-nya masing-masing, seperti yang terlihat pada gambar berikut ini:

Lebih dari 1 fill pada shape yang sama

Lebih dari 1 fill pada shape yang sama

Hal serupa dapat dicapai di Photoshop dengan cara yang lebih rumit, misalnya dengan membuat beberapa fill layer yang dikombinasikan dengan layer mask sehingga hanya berlaku untuk shape yang dikehendaki (bukan bagian gambar lainnya).

Langkah berikutnya, saya menambahkan sebuah persegi panjang baru sehingga gambar saya terlihat seperti pada gambar berikut ini:

Membuat persegi panjang baru

Membuat persegi panjang baru

Untuk memberikan ujung yang baru pada bagian bawah persegi panjang, saya dapat menggunakan Direct Selection Tool untuk memilih kedua anchor point di ujung kiri bawah dan kanan bawah, kemudian mengisi nilai corners seperti pada gambar berikut ini:

Menghaluskan hanya ujung kiri bawah dan kanan bawah

Menghaluskan hanya ujung kiri bawah dan kanan bawah

Hal serupa juga dapat dilakukan di Photoshop dengan cara yang berbeda, yaitu dengan mengisi nilai rounding di window Properties.

Bila pengguna Photoshop seringkali memoles gambar dengan menggunakan brush, maka pengguna Illustrator memoles kartun dengan potongan shape melalui fasilitas Pathfinder. Sebagai contoh, saya bisa menduplikasi persegi panjang yang baru dibuat sebanyak dua kali. Saya kemudian menggeser salah satu persegi panjang ke kanan sebanyak 1 piksel. Setelah itu, saya memilih kedua persegi panjang dan memilih Minus Front dari window Pathfinder untuk memperoleh sebuah shape baru seperti pada gambar berikut ini:

Memakai pathfinder

Memakai pathfinder

Saya kemudian melakukan hal yang sama untuk membuat shape di ujung kanan. Setelah itu, saya bisa memberikan gradiasi berbeda pada shape baru yang terbentuk di ujung kiri dan kanan, seperti pada gambar berikut ini:

Gradiasi berbeda di ujung sisi  kiri dan kanan

Gradiasi berbeda di ujung sisi kiri dan kanan

Karena hasil akhir di Illustrator adalah vector, saya tidak perlu khawatir gambar menjadi rusak saat diperbesar atau diperkecil. Vector aman untuk di-resize. Sebagai contoh, pada hasil akhir berikut ini, gambar dapat ditampilkan dengan baik pada beberapa ukuran yang berbeda:

Gambar dengan ukuran 256 x 256 piksel

Gambar dengan ukuran 256 x 256 piksel

Gambar dengan ukuran 128 x 128  piksel

Gambar dengan ukuran 128 x 128 piksel

Gambar dengan ukuran 64 x 64  piksel

Gambar dengan ukuran 64 x 64 piksel

Gambar dengan ukuran 48 x 48 piksel

Gambar dengan ukuran 48 x 48 piksel

Gambar dengan ukuran 32 x 32 piksel

Gambar dengan ukuran 32 x 32 piksel

Melakukan Front-End Testing Dengan Codeception

Pada artikel Melakukan Front-End Testing Dengan Selenium Tanpa “Mengotori” Database, saya mencoba melakukan pengujian halaman web secara otomatis. Pengujian dilakukan dengan mengisi database dengan data yang konsisten lalu mensimulasikan akses pada browser dan memastikan hasilnya sesuai harapan. Pada artikel ini, saya akan melakukan hal yang sama tetapi dengan menggunakan Codeception. Codeception adalah sebuah ‘framework’ pengujian yang mempermudah menulis kode program pengujian. Dukungan yang dimiliki oleh Codeception ditawarkan dalam bentuk module seperti Selenium2, Webdriver, PhpBrowser, dan lainnya.

Sebagai latihan, saya akan menguji sebuah web sederhana dimana terdapat sebuah halaman yang hanya bisa ditampilkan setelah pengguna login. Proyek web tersebut dibuat dengan menggunakan fasilitas Auth yang disediakan oleh Laravel.

Untuk men-install Codeception pada proyek Laravel, saya akan menggunakan perintah Composer berikut ini:

C:\proyek> composer require "codeception/codeception:*"

Composer akan men-download Codeception pada folder vendor/codeception.

Langkah pertama untuk memakai Codeception adalah menghasilkan file konfigurasi dengan memberikan perintah seperti berikut ini:

C:\proyek> vendor\bin\codecept bootstrap app

Perintah di atas akan menyebabkan Codeception membuat beberapa file baru yang dibutuhkan oleh Codeception di folder app\tests. Folder acceptance, functional dan unit masing-masing mewakili jenis pengujian. Istilah yang dipakai untuk front-end testing disini adalah acceptance testing. Ini yang akan saya pakai nantinya.

Sebelumnya, saya perlu mencari file file acceptance.suite.yml dan mengubah nilai url agar sesuai dengan lokasi URL aplikasi yang hendak diuji. Ini adalah salah satu konfigurasi yang dibutuhkan oleh PHPBrowser. Secara default, Codeception akan memakai module PHPBrowser untuk front-end testing. Karena aplikasi yang saya uji tidak mengandung JavaScript, maka ini adalah pilihan yang masuk akal. Bila hendak menguji interaksi melalui JavaScript pada aplikasi, saya harus memakai module Selenium2.

Untuk membuat sebuah file pengujian baru, saya akan memberikan perintah berikut ini:

C:\proyek> vendor\bin\codecept generate:cept acceptance Login -c app

Perintah di atas akan membuat sebuah file baru bernama LoginCept.php di folder app\tests\acceptance. Saya dapat membuat kode program yang mewakili pengujian di file ini. Sebagai contoh, saya dapat mengubah isinya menjadi seperti berikut ini:

<?php
$I = new WebGuy($scenario);

$I->wantTo('display home page');
$I->amOnPage('home/welcome');
$I->dontSee('Selamat datang');
$I->see('Login');

$I->wantTo('login');
$I->fillField('nama', 'snake');
$I->fillField('password', '12345');
$I->click('Login');
$I->amOnPage('home/welcome');
$I->see('Selamat datang, snake');
$I->seeLink('logout');

Kode program di atas sangat mudah dipahami, bukan? Untuk menjalankannya, saya akan memberikan perintah berikut ini:

C:\proyek> vendor\bin\codecept run

Saya akan memperoleh hasil seperti berikut ini:

Codeception PHP Testing Framework v1.8.5
Powered by PHPUnit 3.7.37 by Sebastian Bergmann.

Acceptance Tests (1) ------------------------
Trying to login (LoginCept.php)         Ok
---------------------------------------------

Functional Tests (0) ------------------------
---------------------------------------------

Unit Tests (0) ------------------------------
---------------------------------------------


Time: 858 ms, Memory: 6.50Mb

OK (1 test, 4 assertions)

Salah masalah dengan pendekatan skenario seperti di atas adalah saya harus memiliki 1 file PHP per skenario. Sebagai contoh, walaupun pada kode program pengujian, saya memiliki 2 buah wantTo(), hasil pengujian hanya menampilkan yang terakhir kali saja (Trying to login). Untuk mengatasi hal seperti ini, saya dapat mendeklarasi pegujian dalam bentuk class. Untuk itu, saya membuat skenario baru dengan memberikan perintah seperti berikut ini:

C:\proyek> vendor\bin\codecept generate:cest acceptance Auth -c app

Perhatikan bahwa pada perintah di atas, saya memakai generate:cest sementara pada perintah sebelumnya, saya memakai generate:cept. Perintah tersebut akan menghasilkan sebuah file baru bernama AuthCest.php di folder acceptance. File tersebut berisi class AuthenticationCest yang akan saya ubah menjadi seperti berikut ini:

<?php
use WebGuy;

class AuthCest
{

    public function visit(WebGuy $I) {
        $I->wantTo('display home page as guest');
        $I->amOnPage('home/welcome');
        $I->dontSee('Selamat datang');
        $I->see('Login');
    }

    /**     
     * @before login
     */
    public function wrongLogin(WebGuy $I) {
        $I->wantTo('login with wrong password');
        $I->lookForwardTo('see error when entering wrong password');
        $I->amOnPage('login/show');
        $I->fillField('nama', 'snake');
        $I->fillField('password', 'wrong password');
        $I->click('Login');                
        $I->seeInField('Nama', 'snake');
        $I->see('Terjadi kegagalan');      
    }

    public function login(WebGuy $I) {
        $I->wantTo('login');
        $I->amOnPage('login/show');
        $I->fillField('nama', 'snake');
        $I->fillField('password', '12345');
        $I->click('Login');
        $I->amOnPage('home/welcome');
        $I->see('Selamat datang, snake');
        $I->seeLink('logout');
    }

    /**     
     * @after login
     */
    public function logout(WebGuy $I) {
        $I->wantTo('logout');
        $I->seeLink('logout');
        $I->click('logout');
        $I->dontSee('Selamat datang');
        $I->see('Nama');
        $I->see('Password');
        $I->see('Login');
    }

}

Bila saya menjalankan pengujian, kali ini saya akan memperoleh hasil seperti:

Codeception PHP Testing Framework v1.8.5
Powered by PHPUnit 3.7.37 by Sebastian Bergmann.

Acceptance Tests (4) ------------------------------------------------
Trying to display home page as guest (AuthCest.visit)           Ok
Trying to login with wrong password (AuthCest.wrongLogin)       Ok
Trying to login (AuthCest.login)                                Ok
Trying to logout (AuthCest.logout)                              Ok
---------------------------------------------------------------------

Functional Tests (0) ------------------------
---------------------------------------------

Unit Tests (0) ------------------------------
---------------------------------------------


Time: 1.59 seconds, Memory: 6.75Mb

OK (4 tests, 15 assertions)

Selain menjalankan pengujian, saya juga bisa mengubah kode program pengujian menjadi sesuatu yang lebih mudah dibaca (oleh mereka yang bukan developer) dengan memberikan perintah berikut ini:

C:\proyek> vendor\bin\codecept generate:scenarios acceptance -c app

Hasilnya dapat dilihat pada folder app/tests/_data/scenarios/acceptance. Saya akan menemukan file seperti Auth_Cest.login.txt, Auth_Cest.logout.txt, dan sebagainya. Sebagai contoh, bila saya melihat isi file Auth_Cest.login.txt, saya akan menemukan hasil seperti berikut ini:

I WANT TO LOGIN

I am on page "login/show"
I fill field "nama","snake"
I fill field "password","12345"
I click "Login"
I am on page "home/welcome"
I see "Selamat datang, snake"
I see link "logout"

Menghasilkan SDOCML Berdasarkan Dokumentasi jQuery

Pada artikel di Menambah Content Assistant Untuk jQuery di Aptana Studio 3, saya mencoba untuk mempelajari cara kerja IDE dan fitur content assist pada platform Eclipse (karena Aptana Studio memakai Eclipse Platform). Saya berhasil membuat content assist untuk jQuery yang bekerja sesuai dengan harapan saya (belum tentu sesuai dengan harapan orang lain, karena ini adalah proyek eksperimen 🙂 ). Syaratnya adalah saya harus memiliki sebuah file SDOCML yang mendeskripsikan jQuery pada proyek yang sedang aktif. JavaScript memang tidak memiliki fitur dokumentasi yang standar dan SDOCML merupakan salah satu yang ada di pasaran. jQuery sendiri memiliki dokumentasi dalam bentuk XML yang mirip seperti SDOCML tapi tidak compatible sehingga saya tidak bisa memakainya secara langsung di Aptana Studio. Apa yang dilihat di http://api.jquery.com dihasilkan berdasarkan file XML tersebut.

Seiring waktu berlalu, file SDOCML yang saya buat bisa kadaluarsa karena API jQuery juga terus berevolusi. Untuk mengatasi masalah tersebut, saya membuat sebuah script Groovy yang kode programnya dapat dilihat di https://github.com/JockiHendry/sdocml-generator/blob/master/generate-jquery.groovy. Script ini akan menghasilkan SDOCML berdasarkan dokumentasi jQuery yang ada. Karena dibuat dengan bahasa pemograman Groovy, maka untuk menjalankannya dibutuhkan Java dan Groovy.

Kenapa memakai Groovy? Karena Groovy menyediakan segala sesuatu yang saya butuhkan sehingga saya bisa bekerja secara cepat. Groovy menyediakan CliBuilder sehingga saya hanya perlu mendaftarkan parameter dan Groovy (tepatnya Apache Commons CLI) akan memeriksa apakah pengguna mengisi parameter dengan benar. Groovy juga menyediakan XmlSlurper sehingga saya bisa membaca dokumentasi resmi jQuery dalam bentuk XML secara mudah. Selain itu, Groovy juga memiliki MarkupBuilder sehingga saya bisa menulis file XML dengan mudah (SDOCML pada dasarnya adalah file XML).

Script ini dapat dijalankan dengan menggunakan perintah seperti:

C:\> groovy generate-jquery.groovy -help
error: Missing required option: output
usage: generate-jquery [options]
 -file      retrieve XML API documentation from XML file
 -help            print this message
 -output    output JsDoc to this file
 -url        retrieve XML API documentation from this URL. Default
                  URL is http://api.jquery.com/resources/api.xml

Dokumentasi jQuery dipublikasikan dalam bentuk XML di lokasi http://api.jquery.com/resources/api.xml. Yang akan dilakukan oleh script ini adalah membaca dokumentasi jQuery tersebut lalu menerjemahkan menjadi file SDOCML yang dapat dipakai oleh Aptana Studio. Dengan demikian, saya bisa mendapatkan dokumentasi terbaru dengan mudah.

Bila komputer terkoneksi dengan internet, maka saya bisa menghasilkan file SDOCML berdasarkan dokumentasi jQuery yang terbaru dengan menggunakan perintah seperti:

C:\> groovy generate-jquery.groovy -url -output jquery.sdocml
Reading XML from url: http://api.jquery.com/resources/api.xml
File jquery.sdocml has been generated!

Bila seandainya saya tidak terkoneksi dengan internet, maka saya bisa menghasilkan file SDOCML berdasarkan file XML yang sudah saya download sebelumnya dengan menggunakan perintah seperti:

C:\> groovy generate-jquery.groovy -file jquery-api.xml -output jquery.sdocml
Reading XML from file: jquery-api.xml
File jquery.sdocml has been generated!

Setelah file SDOCML dihasilkan, saya tinggal meletakkannya pada proyek di Aptana Studio dan content assist-pun akan bekerja berdasarkan dokumentasi yang terbaru. Karena file SDOCML ini dihasilkan secara otomatis, bagian example akan terlihat sangat panjang sekali sesuai dengan yang ada di situs http://api.jquery.com.

Memakai Fasilitas Copy CSS Dari Photoshop CC

Sebagai seorang developer, saya hanya sesekali memakai Adobe Photoshop untuk melakukan photo retouching. Tapi bagi web designer, Photoshop adalah tool yang sangat berguna untuk membuat konsep website yang hendak dirancang. Setelah klien setuju dengan rancangan di Photoshop, maka tim front-end bisa segera mengubah gambar statis di Photoshop tersebut menjadi sebuah website yang responsif melalui Adobe Edge Reflow, Adobe Dreamweaver, dan sebagainya. Website yang responsif biasanya dihasilkan dengan menggunakan CSS layout (kebalikannya, website yang tidak responsif hanyalah komposisi gambar yang di-slice dari Photoshop dengan ukuran yang fixed).

Salah satu fitur menarik dari Photoshop yang berguna bagi saya adalah fasilitas Copy CSS. Fasilitas ini memungkinkan Photoshop untuk menghasilkan CSS berdasarkan layer yang sedang saya pilih. Fitur ini berguna bagi saya karena saya tidak mempublikasikan seluruh rancangan ke Adobe Edge Reflow tapi hanya sesekali perlu men-copy CSS berdasarkan apa yang telah dibuat di Photoshop.

Sebagai contoh, saya memiliki dokumen Photoshop dengan 3 layer seperti pada gambar berikut ini:

Dokumen Photoshop Dengan 3 Layer

Dokumen Photoshop Dengan 3 Layer

Saya kemudian memilih layer dengan nama header, lalu memilih menu Layer, Copy CSS seperti pada gambar berikut ini:

Memilih menu Copy CSS

Memilih menu Copy CSS

Photoshop akan men-copy CSS seperti berikut ini pada clipboard:

.header {
  background-image: -moz-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%);
  background-image: -webkit-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%);
  background-image: -ms-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%);
  position: absolute;
  left: 0px;
  top: 0px;
  width: 4608px;
  height: 822px;
  z-index: 2;
}

CSS ini bisa langsung saya pakai pada HTML. Sebagai contoh, untuk membuktikan bahwa CSS tersebut sesuai dengan tampilan di Photoshop, maka saya membuat sebuah file HTML dengan nama latihan.html yang isinya seperti berikut ini:

<html>
<head>
<title>Latihan</title>
<style>
.header {
   background-image: -moz-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%);
   background-image: -webkit-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%);
   background-image: -ms-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%); 
   position: absolute;
   left: 0px;
   top: 0px;
   width: 4608px;
   height: 822px;
   z-index: 2;
}
</style>
</head>
<body>
<div class='header'>
</div>
</body>
</html>

Bila saya menampilkan HTML tersebut di browser, saya akan memperoleh hasil seperti pada gambar berikut ini:

Hasil di browser

Hasil di browser

Hampir sama seperti di Photoshop, bukan? Hanya saja saya perlu melakukan sedikit pengaturan lagi untuk ukuran dan posisi. Misalnya saya bisa menghilang position: absolute dan mengganti ukuran menjadi seperti left: 0px; top: 0px; width: 100%; height: 200px;.

Bagaimana dengan tulisan? Apakah Photoshop CC juga bisa men-copy drop shadow effect dengan baik? Saya akan mengujinya dengan memilih layer dengan nama title, lalu memilih menu Layer, Copy CSS. Saya akan memperoleh CSS seperti berikut ini di clipboard:

.title {
  font-size: 222.5px;
  font-family: "Charlemagne Std";
  color: rgb( 255, 255, 255 );
  font-weight: bold;
  text-align: center;
  text-shadow: 0px 0px 79px rgb( 210, 248, 93 );
  position: absolute;
  left: -36.363px;
  top: 144.887px;
  width: 2350px;
  height: 365px;
  z-index: 3;
}

Saya akan coba menambahkannya di HTML sehingga isi file latihan.html terlihat seperti berikut ini:

<html>
<head>
<title>Latihan</title>
<style>
.header {
   background-image: -moz-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%);
   background-image: -webkit-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%);
   background-image: -ms-linear-gradient( 90deg, rgb(255,255,255) 0%, rgb(0,0,0) 18%);
   left: 0px;
   top: 0px;
   height: 200px;
}
p.title {
   font-size: 3em;
   font-family: "Charlemagne Std";
   color: rgb( 255, 255, 255 );
   font-weight: bold;
   text-align: center;
   text-shadow: 0px 0px 15px rgb( 210, 248, 93 );
   margin-top: 0px; padding-top: 40px;
}
</style>
</head>
<body>
<div class='header'>
   <p class='title'>The Solid Snake</p>
</div>
</body>
</html>

Saya melakukan sedikit perubahan pada CSS yang dihasilkan oleh Photoshop untuk menyesuaikan dengan posisi yang ada di HTML. Bila saya menampilkan latihan.html di browser, kali ini saya akan memperoleh hasil seperti pada gambar berikut ini:

Hasil di browser

Hasil di browser

Hampir mirip dengan yang ada di Photoshop. Hanya saja saya perlu menyesuaikan posisi dan ukuran sesuai dengan yang dibutuhkan di HTML. Misalnya saya memilih memakai 3em daripada 222.5px karena ukuran dalam satuan px bisa sangat berbeda dari satu platform ke platform lainnya.

Aptana Journal #12: Selesai Tanpa Kiamat

Tanggal 21 Desember 2012 dikabarkan adalah akhir dari peradaban manusia.   Beruntungnya, tanggal 21 sudah berlalu, dan sekarang sudah memasuki tanggal 22 (at least, bila  jam kiamat berdasarkan patokan waktu di Indonesia).   Hari ini memang adalah hari yang melelahkan bagi saya, tapi tidak ada tanda-tanda kiamat selain hujan yang turun terus menerus.  Okay, ini berarti saya masih punya kesempatan untuk membuat post blog baru.

Beberapa waktu lalu, saya membaca panduan kurikulum ilmu komputer yang dirancang oleh ACM (Association for Computing Machinary).   Apa itu ACM?  ACM adalah organisasi yang bergerak di bidang pendidikan dan penelitian advance computing dimana anggotanya adalah para praktisi di bidangnya.  ACM memiliki panduan kurikulum yang kerap dijadikan sebagai masukan oleh berbagai universitas di dunia.

Kurikulum ACM merefleksikan apa yang dibutuhkan oleh industri saat ini.  ACM juga terus merevisi kurikulumnya dengan meminta masukan dari para praktisi di industri.  Ini adalah hal bagus, karena selama ini, saya sering merasa kalangan akademis menciptakan sebuah “dunia semu” bagi mahasiswanya.  Mahasiswa dipacu untuk mengerjakan ujian yang merefleksikan “dunia semu” ini.  Lalu begitu lulus, mahasiswa harus beradaptasi lagi dengan “dunia nyata” (industri!) yang ternyata beda jauh dari “dunia semu” di kampus.  Bukankah sungguh ironis: mahasiswa mati-matian berjuang mendapat nilai ‘A’ hanya untuk kualitas “dunia semu”;  para mafia kampus akan meningkatkan tingkat kesulitan “dunia semu” menjadi “dunia tak jelas” sehingga mereka mendapat ‘uang saku’ tambahan; dan mahasiswa akan berjuang merayu dosen agar tidak pelit nilai (bila sudah kerja nanti, apakah mereka akan merayu bos agar naik gaji?)  Bila ini dibiarkan terus menerus, kampus akan membentuk sebuah ‘sistem’ tersendiri yang semakin terpisah dari dunia industri.  Gelar akademis dan level golongan dosen lama-lama akan menjadi formalitas tanpa isi, tanpa kebanggaan (mungkin yang tersisa hanya ‘egoisme’ anak kecil dalam membela almamater).

Pada panduan yang saya baca, salah satu masukan dari industri adalah untuk meningkatkan pelajaran yang berkaitan dengan keamanan komputer dan software archeology.  Arkeologi?  Ini bukan pelajaran sejarah ‘kan?!  Software archeology adalah sebuah aktifitas untuk mempelajari kode program buatan orang lain dimana seseorang tidak memiliki dokumentasi yang lengkap atas kode program tersebut.  Ibaratkan dengan arkeologi, kode program buatan orang lain tersebut adalah sebuah artifact bersejarah.  Seorang arkeolog akan memprediksi kenapa ada tumpukan batu di dekat kuil kuno, ia akan menganalisa benda-benda sekitarnya untuk menemukan jawaban.  Dalam software archeology,  seseorang juga harus menganalisa kenapa sebuah bagian kode program dibuat dan untuk tujuan apa.

Mengapa software archeology dianggap penting oleh industri?  Karena, pada saat seorang lulusan bekerja di industri, mereka tidak selalu membuat software dari awal.  Kebanyakan yang terjadi adalah mereka harus bergabung dengan tim dimana proyek mungkin sudah berjalan 1 atau 2 bulan.   Kadang-kadang mereka adalah pengganti karyawan lama yang tiba-tiba menghilang sehingga mereka harus bekerja tanpa sempat melalui transfer ilmu.   Suatu hari nanti, mungkin mereka harus merombak sebuah sistem lama yang sudah dibuat 5 tahun lalu dimana seluruh developer-nya sudah resign.  Disinilah software archeology mulai menunjukkan perannya.

Apa yang saya lakukan selama seri artikel ini, mulai dari Aptana Journal #1 hingga Aptana Journal #12, adalah upaya memahami dan mengubah kode program untuk sebuah software yang dibuat orang lain, yaitu Aptana Studio 3.  Saya tidak punya dokumentasi yang lengkap.  Di kode program Aptana Studio 3, tidak selalu ada JavaDoc!    Ini adalah software archeology.  Tidak ada pembuat kode program original untuk ditanyai (bukan karena orang-orang tersebut adalah manusia purba yang sudah punah!)  Tentu saja, software archeology yang serius memiliki metode formal dan terstruktur, dan saya hanya memakai metode menulis dokumentasi dalam HTML (juga ada class diagram dan sequence diagram yang menempel di dinding!).

Mengubah Aptana Studio 3 untuk mendukung jQuery melalui polymorphism ‘semu’ mungkin tidak selalu berguna bagi semua orang, tapi hal ini akan sangat membantu saya.  Salah satu bagian yang cukup melelahkan adalah mendokumentasikan setiap method dan property jQuery yang ada di http://api.jquery.com ke dalam file ScriptDoc XML.   File yang saya buat tersebut dapat ditemukan di https://docs.google.com/open?id=0B-_rVDnaVRCbNEw5OU1WRUdXM1U.

Perilaku content assist dan context info yang telah berubah dapat dilihat pada animasi berikut (ini adalah animasi GIF berukuran 2.5 MB):

Animasi Yang Menunjukkan Hasil Perubahan

Aptana Journal #11: Menambahkan Dukungan Inline JSDoc

Artikel sebelumnya adalah salah satu post yang menarik di akhir tahun 2012 ini karena artikel tersebut adalah artikel ke-212 yang saya tulis di blog ini 🙂

Post ke 212 Untuk Seri ke 10 Di Akhir Tahun 2012

Post ke 212 Untuk Seri ke 10 Di Akhir Tahun 2012

Dan kembali ke artikel 213,  saya dihadapkan permasalahan bagaimana menampilkan content assist untuk argumen dalam anonymous inner function, misalnya yang paling sering ditemui adalah jQuery.Event.  Sebagai contoh, content assist tidak bekerja dengan baik di gambar berikut ini:

Content Assist Tidak Menampilkan proposal untuk object jQuery.Event

Content Assist Tidak Menampilkan proposal untuk object jQuery.Event

Padahal, e adalah sebuah variabel dengan tipe jQuery.Event. Dan saya sudah menambahkan bagian berikut ini ke ScriptDoc XML yang dipakai:

<javascript>
   ... <!-- isi diabaikan -->

   <class type="jQuery.Event">
     <properties>
        <property name="currentTarget" type="Element" scope="instance">
           <description>The current DOM element within the event bubbling phase.</description>
        </property>
     </properties>
   </class>
</javascript>

Dalam bahasa seperti JavaScript, memang sangat sulit untuk menentukan apa tipe dari sebuah variabel.  Tapi, bila programmer JavaScript menambahkan sebuah komentar dengan makna khusus, misalnya JSDoc, maka Aptana Studio bisa mengetahui tipe dari variabel e dan menampilkan content assist untuk variabel tersebut.  Saat ini, Aptana Studio mendukung penggunaan @type untuk elemen selain function sehingga content assist bekerja dengan baik bila saya menambahkan JSDOC tersebut seperti berikut ini:

Menggunakan JSDoc @type di Aptana Studio

Menggunakan JSDoc @type di Aptana Studio

Tapi saya merasa syntax tersebut masih terlalu panjang.  Oleh sebab itu, saya mencoba memodifikasi Aptana Studio agar mendukung inline JSDoc yang lebih singkat.

Hasil penelusuran membawa saya ke class JSTypeUtil di method applyDocumentation(). Method ini akan memeriksa apakah property adalah FunctionElement. Bila iya, maka ia akan memberikan dokumentasi untuk FunctionElement tersebut.  Jika bukan, ia memberikan dokumentasi ke PropertyElement yang ada berdasarkan block.getText(), block.getTags(TagType.TYPE), dan block.getTags(TagType.EXAMPLE) (dimana block adalah sebuah DocumentationBlock).

Untuk mendukung inline JSDOC, saya perlu mengubah alur di atas,  sehingga kode program akan terlihat seperti berikut ini:

public static void applyDocumentation(PropertyElement property, JSNode node, DocumentationBlock block)
{
   if (property instanceof FunctionElement)
   {
       ... // kode program diabaikan
   }
   else
   {
       if (block != null)
       {
           // Bila tidak ada tag TYPE, maka ini adalah sebuah inline JSDOC
           if (block.getTags(TagType.TYPE).isEmpty()) {
              if (!StringUtil.isEmpty(block.getText().trim())) {
                 property.addType(block.getText().trim());
              }
           } else {

              ... // ini adalah kode program semula
           }
       }
   }
}

Sekarang, bila saya memakai inline JSDoc, maka content assist akan bekerja sesuai dengan yang diharapkan seperti pada gambar berikut ini:

Content Assist Untuk Inline JSDoc

Content Assist Untuk Inline JSDoc

Ops!  Tunggu dulu..  Bila saya memperhatikan contoh inline JSDoc di halaman http://code.google.com/p/jsdoc-toolkit/wiki/InlineDocs, terlihat bahwa tidak ada spasi di antara tipe dan komentar.  Versi perubahan saya saat ini masih tidak compatible.

Oleh sebab itu, saya masih perlu melakukan perubahan.  Saya harus mengubah SDoc.flex  dan SDoc.grammar agar mengenali inline JSDoc yang tidak dipisahkan dengan spasi.

Saya mulai dengan menambahkan sebuah definisi terminal baru di /com.aptana.js.core/parsing/SDoc.flex dengan nama INLINE_DOCUMENTATION seperti berikut ini:

%terminals INLINE_DOCUMENTATION;

Lalu, pada definisi rule Block, saya mengubahnya sehingga terlihat seperti berikut ini:

Block
	=	START_DOCUMENTATION Text.text END_DOCUMENTATION
		{:
			return new DocumentationBlock((String) text.value);
		:}
	|	START_DOCUMENTATION Tags.tags END_DOCUMENTATION
		{:
			return new DocumentationBlock((List<Tag>) tags.value);
		:}
	|	START_DOCUMENTATION Text.text Tags.tags END_DOCUMENTATION
		{:
			return new DocumentationBlock((String) text.value, (List<Tag>) tags.value);
		:}
	|	INLINE_DOCUMENTATION.text
	    {:
	    	return new InlineDocumentationBlock((String)text.value);
	    :}
	;

Pada kode program di atas, saya memisahkan antara dokumentasi biasa yang diwakili oleh class DocumentationBlock dan dokumentasi inline yang diwakili oleh class InlineDocumentationBlock.   Saat ini class InlineDocumentationBlock belum ada, sehingga saya perlu membuatnya.   Karena InlineDocumentationBlock pada dasarnya adalah bentuk khusus dari DocumentationBlock, maka saya tinggal menurunkan class tersebut dari DocumentationBlock.   Class baru ini dibuat di package com.aptana.js.internal.core.parsing.sdoc.model di proyek com.aptana.js.core dengan isi seperti berikut ini:

package com.aptana.js.internal.core.parsing.sdoc.model;

/**
 * Model to represent inline doc comments. See 
 * <a href="http://code.google.com/p/jsdoc-toolkit/wiki/InlineDocs">
 * http://code.google.com/p/jsdoc-toolkit/wiki/InlineDocs</a> for example.
 * 
 * @author SolidSnake
 *
 */
public class InlineDocumentationBlock extends DocumentationBlock {

	public InlineDocumentationBlock(String content) {
		super(content);
	}

}

Setelah itu, pada file /com.aptana.js.core/com/aptana/js/internal/core/parsing/sdoc/SDocTokenType.java, di bagian enumeration SDocTokenType, saya menambahkan baris berikut ini:

  INLINE_DOCUMENTATION(Terminals.INLINE_DOCUMENTATION),

Lalu, saya melakukan perubahan di file , dengan menambahkan baris berikut ini di <YYINITIAL>:

  // inline documentation
  "/**" [^ \t\r\n{\[\]#]+ "*/"  {
	String text = yytext(); 
	return newToken(SDocTokenType.INLINE_DOCUMENTATION, text.substring(3,text.length()-2)); }

Perubahan pada scanner generator dan parser generator telah selesai, saya pun mencoba menjalankan build.js.xml untuk memastikan bahwa file Java bisa dihasilkan dengan baik.  Caranya adalah dengan men-klik kanan file build.js.xml, kemudian memilih Run As, Ant Build.  Setelah memastikan bahwa Console menampilkan tulisan BUILD SUCCESSFUL,  saya mencoba me-refresh package com.aptana.js.internal.core.parsing.sdoc dengan men-klik kanan package tersebut dan memilih Refresh.

Perubahan terakhir yang perlu saya lakukan kembali lagi ke class JSTypeUtil di method applyDocumentation(). Saya kembali mengubah method tersebut sehingga terlihat seperti berikut ini:

public static void applyDocumentation(PropertyElement property, JSNode node, DocumentationBlock block)
{
  if (property instanceof FunctionElement)
  {
    applyDocumentation((FunctionElement) property, node, block);
  }
  else
  {
    if (block != null)
    {
      if (block instanceof InlineDocumentationBlock) {

        if (!StringUtil.isEmpty(block.getText().trim())) {
          property.addType(block.getText().trim());
        }

      } else {

        // apply description
        property.setDescription(block.getText());

        // apply types
        for (Tag tag : block.getTags(TagType.TYPE))
        {
          TypeTag typeTag = (TypeTag) tag;

          for (Type type : typeTag.getTypes())
          {
            ReturnTypeElement returnType = new ReturnTypeElement();

            returnType.setType(type.toSource());
            returnType.setDescription(typeTag.getText());
            property.addType(returnType);
          }
        }

        // apply examples
        for (Tag tag : block.getTags(TagType.EXAMPLE))
        {
          ExampleTag exampleTag = (ExampleTag) tag;

          property.addExample(exampleTag.getText());
        }

      }
    }
  }
}

Sekarang, inline JSDoc bisa bekerja dengan baik seperti yang terlihat pada gambar berikut ini:

Inline JSDoc yang bekerja dengan baik

Inline JSDoc yang bekerja dengan baik

Aptana Journal #10: Menampilkan Parameter Di Content Assist

Walaupun berhasil menampilkan ‘polymorphism‘ di content assist, seluruh nama method yang muncul selalu dengan nama yang sama.  Hal ini terkadang bisa sangat membingungkan.  Oleh sebab itu, saya ingin melakukan perubahan dimana nama method yang muncul di content assist juga menyertakan parameter.

Untuk itu, saya perlu mengubah method addProposal(Set<ICompletionProposal>, PropertyElement, int, URI, String, String[] di class JSContentAssistProcessor dengan menambahkan bagian seperti berikut ini:

PropertyElementProposal proposal = null;
if (property instanceof FunctionElement) {
  FunctionElement function = (FunctionElement) property;
  String documentation = JSModelFormatter.CONTEXT_INFO.getDocumentation(function);
  ContextInformation contextInformation = new ContextInformation(function.getName(), documentation);

  String proposalValue = StringUtil.join(null, function.getName(), "(",
    StringUtil.join(", ", function.getParameterNames()), ")");
  proposal = new PropertyElementProposal(proposalvalue, function.getName()+"()", function.getName().length()+1,
    function, offset, replaceLength, projectURI, contextInformation);
}

Langkah berikutnya adalah mengubah constructor yang pernah saya tambahkan di PropertyElementProposal.  Saya akui bahwa perubahan ini bukan yang terbaik, karena saya hanya menambah tanpa berani mengubah karena takut merusak yang sudah ada.  Akibatnya, parameter constructor terlihat panjang seperti berikut ini:

public PropertyElementProposal(String displayString, String replacementString, int cursorPosition,
  PropertyElement property, int offset, int replaceLength, URI uri, ContextInformation contextInformation)
{
  super(replacementString, offset, replaceLength, cursorPosition, null, displayString, 
    contextInformation, null);
  this.property = property;
  this.uri = uri;
}

Perjuangan belum selesai sampai disini, karena urutan tampilnya content assist tiba-tiba jadi berantakan.  Saya perlu mencari tahu kenapa, dan akhirnya menemukan jawaban di method validate() milik CommonCompletionProposal. Sebagai informasi, class PropertyElementProposal adalah turunan dari CommonCompletionProposal, sehingga method validate() ini ikut dipanggil. Berikut adalah isi method validate():

public boolean validate(IDocument document, int offset, DocumentEvent event)
{
  if (offset < this._replacementOffset)
    return false;

  int overlapIndex = getDisplayString().length - _replacementString.length();
  overlapIndex = Math.max(0, overlapIndex);
  String endPortion = getDisplayString().substring(overlapIndex);
  boolean validated = isValidPrefix(getPrefix(document, offset), endPortion);

  if (validated && event!=null)
  {
     // ... kode program diabaikan
  }

  return validated;
}

Karena nilai _displayString sangat berbeda dengan nilai _replacementString, maka hasil variabel endPortion jadi aneh.  Tapi karena kode program ini bukan saya yang buat, saya tidak mengerti apa tujuan awalnya.

Lalu apa saya harus mengubah method validate() di CommonCompletionProposal?   Tidak, lebih baik saya men-override method validate() ini di PropertyElementProposal sehingga perubahan tidak berdampak CommonCompletionProposal yang lain.   Oleh sebab itu, saya menambahkan method berikut ini di PropertyElementProposal (yang isinya hampir sama seperti di CommonCompletionProposal:

@Override
public boolean validate(IDocument document, int offset, DocumentEvent event)
{
	if (offset < this._replacementOffset)
		return false;

	int posisiKurung = getDisplayString().indexOf('(');
	String propertyName = null;
	if (posisiKurung == -1) {
		propertyName = getDisplayString();
	} else {
		propertyName = getDisplayString().substring(0, getDisplayString().indexOf('('));
	}
	int overlapIndex = propertyName.length() - _replacementString.length();
	overlapIndex = Math.max(0, overlapIndex);
	String endPortion = getDisplayString().substring(overlapIndex);
	boolean validated = isValidPrefix(getPrefix(document, offset), endPortion);

	if (validated && event != null)
	{
		// make sure that we change the replacement length as the document content changes
		int delta = ((event.fText == null) ? 0 : event.fText.length()) - event.fLength;
		final int newLength = Math.max(_replacementLength + delta, 0);
		_replacementLength = newLength;
	}

	return validated;
}

Sekarang, content assist untuk method yang memiliki banyak variasi tidak akan terlihat membingungkan lagi karena sudah ada informasi parameter seperti yang terlihat pada gambar berikut ini:

Content Assist Dengan Informasi Parameter

Content Assist Dengan Informasi Parameter

Aptana Journal #9: Mengorbankan Static Method

Pada Journal #1, saya melakukan perubahan pada ParserUtil di method getParentObjectTypes() dimana saya menganggap seluruh referensi jQuery adalah ke Function<jQuery> bukan Class<jQuery>.  Dengan kata lain, saya menganggap semua penggunaan jQuery berdasarkan instance, misalnya: $("p").blur(). Padahal, pada kenyataannya, ada beberapa method jQuery yang dapat diakses tanpa harus membuat instance, misalnya: $.ajax().  Method seperti ini adalah method static.   Dengan pendekatan yang saya tempuh saat ini, seluruh method, baik yang static maupun per-instace, akan ditampilkan dalam content assist saat pengguna mengetik jQuery atau $.   Saya pikir trade-off ini masih dapat diterima bila dibandingkan dengan keuntungan yang saya peroleh saat melakukan coding jQuery nanti (membuat widget, misalnya).

jQuery mengandung beberapa definisi class yang dapat dipakai diluar, misalnya Callbacks, Deferred, dan jqXHR.  Kebanyakan dari class tersebut dapat dibuat dengan constructor berupa method static di object jQuery.   Karena saya tidak mendukung method static, maka saya mendokumentasikan seluruh constructor sebagai function biasa (per-instance).

Permasalahan yang saya hadapi adalah content assist tidak bekerja dengan baik untuk constructor tersebut.  Aptana Studio menganggap seluruh constructor tersebut mengembalikan sebuah Object yang universal.

Mengapa demikian?  Untuk menjawab pertanyaan ini, saya pun melakukan penelusuran, yang membawa saya pada class JSNodeTypeInferrer. Class ini memiliki sebuah method dengan nama visit() dimana berisi cuplikan seperti berikut ini:

public void visit(JSGetPropertyNode node)
{
   ... // kode diabaikan
   // TODO Combine with similiar code from ParseUtil.getParentObjectTypes
   if (JSTypeCOnstants.FUNCTION_JQUERY.equals(typeName)
          && lhs instanceof JSIdentifierNode
          && (JSTypeConstants.DOLLAR.equals(lhs.getText()) || JSTypeConstants.JQUERY.
                 .equals(lhs.getText())))
   {
       typeName = JSTypeConstants.CLASS_JQUERY;
   }
   ... // kode diabaikan
}

Wow!  Sesuai dengan komentar TODO di atas-nya,  disini telah terjadi duplikasi kode program.  Bila saya menghilangkan logic di ParseUtil.getParentObjectTypes() (petualangan di journal #1), maka saya WAJIB  menghilangkan bagian yang ini juga!  Ini bisa membingungkan orang-orang, terutama saya yang berasumsi bahwa perubahan pada ParseUtil sudah menyelesaikan masalah, tetapi disini juga perlu diubah.  Untuk itu, saya memberikan komentar pada baris di atas sehingga mereka tidak akan mengubah Function<jQuery> menjadi Class<jQuery>.

Tapi petualangan belum berakhir sampai disini.  Setelah tipe class bisa ditemukan dengan baik, Apatana Studio tetap tidak mengembalikan method yang spesifik untuk class tersebut, melainkan hanya class bersifat umum yaitu Object.

Mengapa demikian?  Penelusuran kode program membawa saya ke method addTypeProperties() di class JSContentAssistProcessor.  Pada method ini terdapat sebuah baris kode program seperti berikut ini:

Collection properties = indexHelper.getTypeMembers(index, allTypes);

Lalu, apa isi dari method getTypeMembers()? Isinya seperti berikut ini:

public Collection getTypeMembers(Index index, List<String> typeNames) {
return CollectionsUtil.union(getMembers(index, typeNames), getMembers(getIndex(), typeNames));
}

Pada saat melakukan tracing, masing-masing getMembers() telah mengembalikan method yang valid dan benar.  Tetapi pada saat keduanya digabungkan kedalam sebuah Set, selalu ada yang hilang!  Hal ini tiba-tiba mengingatkan saya pada ‘bug‘ yang saya temui di journal #4 sehubungan dengan nilai di Set yang menghilang.   Ternyata benar, class FunctionElement belum memiliki method equals() dan hashCode().  Saya segera memilih menu Source, Generate hashCode() and equals().

Sampai disini semua sudah mendingan, tapi petualangan belum berakhir.  Mengapa demikian?  Karena method yang muncul selalu terduplikasi, ada yang mengandung dokumentasi dan ada yang tidak.  Padahal, saya menginginkan hanya yang mengandung dokumentasi saja yang ditampilkan (dan tampilkan versi tidak terdokumentasi bila seandainya tidak ada yang lebih baik).

Untuk mengatasi permasalahan tersebut, saya mengubah method visit di JSNodeTypeInfererrer menjadi seperti:

public void visit(JSGetPropertyNode node)
{
   ... // kode program diabaikan
   if (properties!=null)
   {
      for (PropertyElement property: properties)
      {
          if (property instanceof FunctionElement)
          {
              FunctionElement function = (FunctionElement) property;
              boolean adaVersiTerdokumentasi = false;
              if (function.getDescription()==null || function.getDescription().length()==0) {
                  for (PropertyElement item: properties) {
                     if (item instanceof FunctionElement && item.getName().equals(function.getName()) && 
                         item.getDescription()!=null && item.getDescription().length()>0) {
                         adaVersiTerdokumentasi = true;
                     }
                  }
              }
              if (adaVersiTerdokumentasi) continue;

              ... // kode program diabaikan
          }

          ... // kode program diabaikan
      }
   }
}

Belajar dari petualangan hari ini, saya sudah beberapa kali melakukan filtering elemen yang mengandung dokumentasi.  Sepertinya logika ini bisa dikumpulkan ke sebuah class sehingga saat melakukan perubahan, saya cukup mengubah class tersebut.

Sekarang, saya akan melakukan pengujian, misalnya, saya akan memanggil method static Callback seperti berikut ini:

Menampilkan Content Assist Untuk $

Menampilkan Content Assist Untuk $

Context info untuk method tersebut akan muncul seperti yang terlihat di gambar berikut ini:

Menampilkan Context Info Untuk Callbacks

Menampilkan Context Info Untuk Callbacks

Setelah itu, bila saya memanggil salah satu method object Callbacks, maka content assist akan muncul, seperti berikut ini:

Menampilkan Content Assist Untuk  Object Callbacks

Menampilkan Content Assist Untuk Object Callbacks

Beruntungnya, content assist pada saat terjadi chaining tetap bekerja dengan baik seperti yang terlihat di gambar berikut ini:

Content  assist setelah method add di Calllbacks

Content assist setelah method add di Calllbacks

Aptana Journal #8: Example

Pada file ScriptDoc XML yang saya buat, saya selalu menyertakan bagian <examples>  seperti berikut ini:

<examples>
  <example>Find all div elements within an XML document from an Ajax response.
   $("div", xml.responseXML);</example>
</examples>

Saat ini, isi examples tersebut tidak akan ditampilkan di context info ataupun di proposal content assist.  Lalu, kapan ditampilkan?  Pada saat hover (meletakkan mouse agak lama) pada posisi perintah JavaScript, akan muncul sebuah dialog yang berisi dokumentasi.  Saya merasa lebih baik bila context info juga menyertakan isi examples sehingga saya bisa mengetahui dengan cepat cara pakai method JavaScript yang sedang saya ketik.

Bagaimana caranya?  Beruntungnya, rancangan Aptana Studio cukup baik, karena hal-hal yang berkaitan dengan penampilan context info berada di satu class yaitu JSModelFormatter.  Class ini menyediakan instance static-nya dengan nama CONTEXT_INFO seperti yang terlihat di cuplikan kode program berikut ini:

public static final JSModelFormatter CONTEXT_INFO = new JSModelFormatter(false, Section.SIGNATURE)
{
   private static final String BULLET = "\u2022";
   private TagStripperAndTypeBolder stripAndBold = new TagStripperAndTypeBolder();

   public String getDocumentation(Collection<PropertyElement> properties)
   {
      ...
   }
}

Nilai String yang dikembalikan oleh method getDocumentation() di atas akan langsung ditampilkan sebagai context info.  Dengan demikian, bila saya ingin menampilkan examples pada context info, maka saya dapat menambahkan baris program di sekitar akhir dari method yang isinya seperti berikut ini:

result.add("\nExamples:");
result.add(StringUtil.concat(function.getExamples()));

Sekarang, bila saya menampilkan context info, saya juga akan memperoleh informasi examples seperti yang terlihat pada gambar berikut ini:

Tampilan Context Info Disertai Examples

Tampilan Context Info Disertai Examples

Aptana Journal #7: Alias

Pada petualangan sebelumnya, constructor jQuery berhasil dimunculkan dengan baik.  Tapi hal ini tidak berlaku untuk $.  Sebagai informasi, $ adalah alias untuk jQuery sehingga apa yang muncul sebagai constructor jQuery juga harus muncul sebagai $.   Pendekatan yang saya pakai mungkin akan menghilangkan perbedaan antara static method dan instance method, tapi ini adalah trade-off yang masih dapat ditoleransi.   Okay, tapi content assist dan context info untuk $  saat ini tidak bekerja dengan baik!  Padahal, saya sudah menambahkan baris berikut ini di file *.sdocml:

... 
  <aliases>
    <alias name="$" type="jQuery" />
  </aliases>
...

Mengapa content assist masih tidak bekerja dengan baik?  Untuk menjawab pertanyaan ini, saya kembali melihat isi method index() di class SDocMLFileIndexingParticipant. Bagian yang menarik adalah di berikut ini:

public void index(BuildContext context, Index index, IProgressMonitor monitor) throws CoreException
{

   ... // diabaikan

   // process results
   JSIndexWriter indexer = new JSIndexWriter();
   TypeElement[] types = reader.getTypes();
   AliasElement[] aliases = reader.getAliases();
   URI location = context.getURI();

   ... // diabaikan

   for (AliasElement alias: aliases)
   {
      String typeName = alias.getType();
      PropertyElement property = window.getProperty(typeName);
      if (property!=null)
      {
         if (property instanceof FunctionElement)
         {
            property = new FunctionElement((FunctionElement) property);
         }
         else
         {
            property = new PropertyElement(property);
         }
         property.setName(alias.getName());
      }
      else 
      {
         property = new PropertyElement();
         property.setName(alias.getName());
         property.addType(typeName);
      }
      window.addProperty(property);
   }

   indexer.writeType(index, window, location);

   ... // kode diabaikan
}

Pada kode program di atas, terlihat bahwa window.getProperty(typeName) akan dipanggil untuk mendapatkan tipe alias. Hasil kembaliannya selalu 1 buah PropertyElement!  Padahal $ harusnya adalah alias untuk seluruh variasi constructor jQuery (yang jumlahnya lebih dari 1).

Oleh sebab itu, saya menambahkan sebuah method baru di class TypeElement yang akan mengembalikan seluruh PropertyElement dengan nama yang sama (bila ada!). Berikut ini adalah isi method tersebut:

public List<PropertyElement> getProperties(String name)
{
  List<PropertyElement> listReturn = new ArrayList<PropertyElement>();
  if (name!=null && name.length()>0 && this._properties!=null) {
    for (PropertyElement property: this._properties) {
      if (name.equals(property.getName())) {
        listReturn.add(property);
      }
    }
  }
  return listReturn;
}

Berikutnya saya menyesuaikan method index() di SDocMLFileIndexingParticipant agar memanggil method yang baru saya buat di atas, dimana perubahan yang saya lakukan terlihat seperti berikut ini:

... // kode program di abaikan
for (AliasElement alias: aliases)
{
  String typeName = alias.getType();
  List<PropertyElement> listProperties = window.getProperties(typeName);
  if (listProperties.size() > 0) {
    for (PropertyElement property: listProperties) {
      if (property instanceof FunctionElement) {
        property = new FunctionElement((FunctionElement) property);
      } else {
        property = new PropertyElement(property);
      }
      property.setName(alias.getName());
      window.addProperty(property);
    }
  } else {
    PropertyElement property = new PropertyElement();
    property.setName(alias.getName());
    property.addType(typeName);
    window.addProperty(property);
  }
}
... // kode program diabaikan

Perjuangan masih belum selesai sampai disini!  Karena deskripsi dokumentasi tiba-tiba saja hilang entah kemana!!! Loh?  Mengapa?

Untuk menjawab keanehan baru tersebut, saya memeriksa isi constructor FunctionElement. Okay, constructor akan men-copy beberapa nilai dari base seperti _parameters, _returnTypes, dan sebagainya. Tidak ada yang men-copy _description disini!

Okay, berarti copy _description mungkin dilaksanakan di parent class-nya yaitu PropertyElement. Jadi, saya memeriksa isi constructor PropertyElement. Disini beberapa nilai dari base seperti _owningType, _types dan _examples akan di-copy! Tapi tidak ada yang men-copy _description sama sekali!  Wow, padahal _examples saja di-copy disini, masa _description tidak diikutkan? Oleh sebab itu, saya mengubah constructor PropertyElement sehingga terlihat seperti berikut ini:

public PropertyElement(PropertyElement base)
{
  this._owningType = base.getOwningType();
  this._isInstanceProperty = base.isInstanceProperty();
  this._isClassProperty = base.isClassProperty();
  this._isInternal = base.isInternal();
  this._types = new ArrayList<ReturnTypeElement>(base.getTypes());
  this._examples = new ArrayList<String>(base.getExamples());

  // Menambah deskripsi
  super.setDescription(base.getDescription());
}

Sekarang content assist dan context info untuk $ dapat bekerja dengan baik seperti yang terlihat di gambar berikut ini:

Content Assist  Untuk Tanda $

Content Assist Untuk Tanda $