SketchUp Ruby API ilə plagin hazırlamağa giriş: addım-addım bələdçi

Bu bələdçidə nə öyrənəcəksiniz?

SketchUp Ruby API SketchUp modelləri və tətbiqi ilə qarşılıqlı əlaqə yaratmaq üçün istifadə olunan interfeysdir. SketchUp-ın rəsmi sənədlərinə görə, API SketchUp tətbiqinin daxilində istifadə edilə bilər; müstəqil işləyən alət deyil. Buna görə inkişafa başlayarkən ilk qərar avtomatlaşdırılacaq işin SketchUp daxilində necə bir plaginə çevriləcəyini müəyyənləşdirmək olmalıdır.

Bu bələdçi API-nin sərhədlərini anlamağa, uyğun rəsmi başlanğıc resurslarını seçməyə, IDE və sazlama hazırlıqlarını görməyə, sonra isə test prosesini qurmağa yönəlib. Müəyyən SketchUp versiyası üçün API uyğunluğu və ya quraşdırma addımları mənbələrdə ətraflı izah edilmədiyindən burada versiya və ya menyu yolu ilə bağlı fərziyyə irəli sürülmür.

Tələblər və başlamazdan əvvəl

• SketchUp: Ruby API SketchUp daxilində işləyir və müstəqil istifadə edilə bilməz. Buna görə inkişaf və sınaq prosesi üçün SketchUp tətbiqi lazımdır.

• Ruby biliyi: Mənbələr API-ni Ruby vasitəsilə müəyyən edir. Qabaqcıl Ruby biliklərinin mütləq tələb olduğu qeyd olunmur; ancaq yazılacaq plagin Ruby-dən istifadə edir.

• Tərtibatçı resursları: Rəsmi SketchUp Ruby API sənədləri, Ruby API Overview və SketchUp Developer Center başlanğıc üçün müraciət edilə bilən resurslardandır.

• IDE və sazlama: SketchUp Ruby Debug protokolunu dəstəkləyən IDE və redaktorlarla istifadə oluna bilən sazlama interfeysi təqdim edir. RubyMine üçün quraşdırma nümunəsi, VSCode üçün isə layihə nümunəsi var.

• Test: SketchUp daxilində işləyən kodu SketchUp-dan kənar Ruby konsolu üçün nəzərdə tutulmuş standart test axınları ilə yoxlamaq çətin ola bilər. TestUp bu istifadə üçün Minitest əsasında qurulmuş örtük və testləri idarə etmək üçün qrafik interfeys təqdim edir.

Mənbələrdə ödəniş, hesab tələbi və ya bütün SketchUp versiyaları üçün uyğunluq cədvəli barədə məlumat verilmir. Buna görə layihəyə başlamazdan əvvəl hədəflənən SketchUp versiyasının rəsmi API sənədləri və nümunələri ayrıca nəzərdən keçirilməlidir.

SketchUp Ruby API ilə inkişaf addımları

1. Avtomatlaşdırılacaq işi müəyyənləşdirin

Əvvəlcə plaqinin hansı təkrarlanan işi asanlaşdıracağını dəqiqləşdirin. SketchUp Developer Center plaginlərin iş axınlarını avtomatlaşdıra və xarici məlumatlarla inteqrasiya yarada biləcəyini bildirir. Bu, layihənin əhatə dairəsini müəyyənləşdirmək üçün faydalı başlanğıc nöqtəsidir; ancaq görüləcək işin API-də hansı metodlarla həyata keçiriləcəyini müvafiq sənədlərdən yoxlamaq lazımdır.

İlk mərhələdə əhatə dairəsini kiçik saxlamaq plaqinin hansı girişləri qəbul edəcəyini və istifadəçiyə hansı nəticəni təqdim edəcəyini anlamağı asanlaşdırır. Bu, layihə planlaşdırma tövsiyəsidir; konkret API xüsusiyyəti və ya SketchUp daxilində menyu addımı deyil.

2. Rəsmi icmal və nümunələrlə irəliləyin

SketchUp Ruby API sənədlərindəki Ruby API Overview əsas istiqamət mənbəyidir. Rəsmi sənədlər, həmçinin geniş yayılmış ssenariləri və anlayışları izah edən nümunələrə və təlimlərə keçid verir. İlk tətbiqdə nümunələri araşdırın və plaqinin məqsədinə uyğun olanları seçin; sənəddə göstərilməyən sinif, metod və ya davranışları fərz etməkdənsə, onların izahını yoxlayın.

SketchUp Developer Center də başlanğıc materiallarını, nümunə genişlənmələri və API resurslarını bir araya gətirir. Buradakı materiallar plaqinin SketchUp daxilində yeni alətlər və funksiyalar təqdim etmə yanaşmasını anlamağa kömək edə bilər. Genişlənməni başqaları ilə paylaşmaq istəyirsinizsə, Extension Warehouse-da dərc etmək seçimi də Developer Center-də göstərilir.

3. IDE-nizi API üçün hazırlayın

Ruby API stub-ları inkişaf mühitinin SketchUp API-si haqqında məlumatlı olmasına kömək etmək üçün təqdim olunur. Rəsmi resurslarda RubyMine üçün layihənin hazırlanması izahı və VSCode üçün layihə nümunəsi var. İstifadə etdiyiniz IDE-yə uyğun nümunəni seçin və sənədləşdirilmiş quraşdırma addımlarını izləyin.

Sazlama üçün SketchUp Ruby Debugger interfeysindən istifadə etmək mümkündür. Bu interfeys Ruby Debug protokolunu dəstəkləyən redaktor və IDE-lərin sazlama funksiyaları ilə işləmək üçün nəzərdə tutulub. Mənbələrdə konkret IDE-nin məcburi olduğu deyilmir; buna görə seçim inkişaf komandasının mövcud alətlərinə əsasən edilə bilər.

4. API çağırışlarını əsas axında saxlayın

Rəsmi API sənədlərində Ruby API ilə bütün qarşılıqlı əlaqələrin əsas axında icra edilməli olduğu barədə xəbərdarlıq edilir. Əks halda gözlənilməz davranışlar və tətbiqin qeyri-sabitliyi yarana bilər. Bu şərti plaqinin dizaynı zamanı nəzərə alın; xüsusilə iş axınını ayrı-ayrı hissələrə bölən struktur planlaşdırılırsa, müvafiq əməliyyatların necə icra olunacağını rəsmi sənədlərə əsasən yoxlayın.

Bu xəbərdarlıq yalnız dərc mərhələsində yoxlanacaq bir detal deyil, inkişaf və test planının bir hissəsidir. Plagin gözlənilən nəticəni versə belə, əsas axın tələbi nəzərdən qaçırılmamalıdır.

5. Testləri SketchUp daxilində başladın

Rəsmi mənbədə SketchUp-dan kənarda işləyən Ruby testlərinin tətbiqin daxilində icra olunmalı kodu yoxlamaq üçün kifayət etməyə biləcəyi bildirilir. TestUp Minitest əsasında qurulmuş həll kimi bu ehtiyaca cavab verir və testləri idarə etmək üçün qrafik interfeys təqdim edir. Test ssenarilərini plaqinin hədəflədiyi davranışları yoxlayacaq şəkildə yaradın və testləri SketchUp daxilindəki istifadə şəraitində qiymətləndirin.

Mənbələrdə TestUp üçün hər test növünün necə yazılacağına dair ətraflı nümunələr verilmədiyindən, test infrastrukturuna keçərkən alətin rəsmi deposundakı izahları və API təlimlərini izləmək lazımdır. Bu yanaşma sənədlərdə olmayan test sintaksisini və ya avtomatik quraşdırma addımını fərz etməyin qarşısını alır.

6. LayOut dəstəyi lazımdırsa, əhatə dairəsini yoxlayın

Ruby API SketchUp 2018-dən etibarən LayOut sənədləri yaratmaq və redaktə etmək dəstəyi də təqdim edir. LayOut Ruby API-nin də yalnız SketchUp daxilində istifadə edilə bildiyi qeyd olunur. Plagin LayOut sənədlərinə müdaxilə etməlidirsə, bunu ayrıca tələb kimi nəzərdən keçirin və LayOut API Overview sənədlərini araşdırın. Mənbələr daha ətraflı versiya uyğunluğu və istifadə addımları vermədiyindən, bu mövzularda müvafiq rəsmi sənədlərə müraciət etmək lazımdır.

Tez-tez rast gəlinən səhvlər

• API-ni müstəqil işə salmağa çalışmaq: Ruby API SketchUp olmadan istifadə edilə bilən müstəqil alət deyil.

• Əsas axın xəbərdarlığını nəzərdən qaçırmaq: API ilə qarşılıqlı əlaqə əsas axında aparılmalıdır; əks halda tətbiq qeyri-sabit ola bilər.

• SketchUp-dan kənar testləri yetərli saymaq: SketchUp daxilində işləyən kod üçün TestUp kimi tətbiqdaxili test seçimlərini nəzərdən keçirin.

• Sənədləşdirilməmiş detalları fərz etmək: Versiya, metod və uyğunluq məlumatlarını rəsmi API sənədlərindən yoxlayın.

• IDE konfiqurasiyasını ötürmək: API stub-ları, IDE nümunələri və sazlama təlimatları inkişaf mühitini hazırlamaq üçün mövcud resurslardır.

Növbəti addımlar

İlk plagin tamamlandıqdan sonra istifadə məqsədi tələb edirsə, onu dərc etmək variantını nəzərdən keçirin. SketchUp Developer Center genişlənmələrin Extension Warehouse-da paylaşıla biləcəyini bildirir. Extension Warehouse-dan kənar paylama planlaşdırılırsa, Developer Center rəqəmsal imzalama və təhlükəsizlik sertifikatı prosesinə də yönləndirir.

Daha mürəkkəb funksiyalar üçün rəsmi mənbələrdə Ruby C genişlənmələrinə dair nümunələr də var. Bunlar daha mürəkkəb funksiyalar və mümkün performans yaxşılaşdırmaları üçün seçim kimi təqdim olunur; hər layihə üçün zəruri olduqları deyilmir. Əvvəlcə Ruby API ilə həllin sərhədlərini müəyyənləşdirib, sonra müvafiq nümunələri araşdırmaq daha nəzarətli inkişaf prosesi yaradır.

Mənbə və lisenziya

Bu bələdçi SketchUp Ruby API-nin rəsmi sənədləri və SketchUp Developer Center-dəki tərtibatçı resursları əsasında Azərbaycan dilinə uyğunlaşdırılıb. Mənbə qeydlərində hər iki səhifə “sərbəst” kimi işarələnib; əlavə olaraq konkret Creative Commons lisenziyası göstərilməyib.