يمكن أن يكون بناء إضافة (Plugin) في Discourse بسيطًا للغاية، بمجرد أن تتعرف على بعض التفاصيل الخاصة بالنظام. الهدف من هذا المنشور هو إنشاء هيكل أساسي للإضافة وتعريفك بالأساسيات.
بيئة التطوير الخاصة بك
تأكد من وجود بيئة تطوير لـ Discourse تعمل على جهازك. أوصيك باستخدام دليل الإعداد المناسب والعودة هنا بعد الانتهاء.
plugin.rb
استخدم GitHub - discourse/discourse-plugin-skeleton: Template for Discourse plugins · GitHub لإنشاء هيكل أساسي كامل لإضافة في Discourse في مجلد الإضافات (plugins) الخاص بك
تم تضمين الهيكل الآن في نواة Discourse، الأمر
rake plugin:create[plugin-name]سيقوم بإنشاء إضافة باستخدام الهيكل الأساسي
عند بدء تشغيل Discourse، يبحث في مجلد plugins عن المجلدات الفرعية التي تحتوي على ملف plugin.rb. لملف plugin.rb غرضان: فهو يعمل كقائمة تعريف (Manifest) لإضافتك مع المعلومات المطلوبة عنها، بما في ذلك اسمها، ومعلومات الاتصال بها، ووصفها. الغرض الثاني هو تهيئة أي كود Ruby ضروري لتشغيل إضافتك.
في حالتنا، لن نضيف أي كود Ruby، ولكننا لا نزال بحاجة إلى ملف plugin.rb. لنقم بإنشاء مجلد باسم basic-plugin مع الملف plugin.rb بداخله، مع المحتوى التالي:
basic-plugin/plugin.rb
# name: basic-plugin
# about: A super simple plugin to demonstrate how plugins work
# version: 0.0.1
# authors: Awesome Plugin Developer
# url: https://github.com/yourusername/basic-plugin
بمجرد إنشاء هذا الملف، يجب عليك إعادة تشغيل خادمك المحلي، وستتم تحميل الإضافة.
مسألة مهمة! (Gotcha)
إذا كنت معتادًا على تطوير Rails التقليدي، فقد تلاحظ أن الإضافات ليست مريحة جدًا عندما يتعلق الأمر بإعادة التحميل. بشكل عام، عند إجراء تغييرات على إضافتك، يجب عليك إيقاف تشغيل الخادم باستخدام Ctrl+c، ثم تشغيله مرة أخرى باستخدام bin/dev.
لم يتم تطبيق تغييراتي! 
أحيانًا لا يتم مسح ذاكرة التخزين المؤقت (Cache) بالكامل، خاصة عند إنشاء ملفات جديدة أو حذف الملفات القديمة. للتغلب على هذه المشكلة، احذف مجلد tmp وقم بتشغيل rails مرة أخرى. على أجهزة Mac، يمكنك تنفيذ ذلك بأمر واحد: rm -rf tmp; bin/dev.
التحقق من تحميل إضافتك
بعد إعادة تشغيل خادمك المحلي، تفضل بزيارة الرابط /admin/plugins (تأكد أولاً من أنك مسجل الدخول كحساب مسؤول، حيث يمكن للمسؤولين فقط رؤية سجل الإضافات).
إذا سارت كل الأمور على ما يرام، يجب أن ترى إضافتك في القائمة:
تهانينا، لقد قمت للتو بإنشاء إضافتك الأولى!
لنقم بإضافة بعض كود JavaScript
حاليًا، إضافتك لا تقوم بأي شيء. لنقم بإضافة ملف javascript يعرض صندوق تنبيه (alert box) عند تحميل Discourse. سيكون هذا الأمر مزعجًا جدًا لأي مستخدم ولا يُنصح به كإضافة فعلية، لكنه سيوضح كيفية إدخال JavaScript في تطبيقنا قيد التشغيل.
أنشئ الملف التالي:
plugins/basic-plugin/assets/javascripts/discourse/initializers/alert.js
export default {
name: "alert",
initialize() {
alert("alert boxes are annoying!");
},
};
الآن، إذا قمت بإعادة تشغيل خادمك المحلي، يجب أن ترى النص “alert boxes are annoying!” يظهر على الشاشة. (إذا لم يظهر، راجع عنوان “لم يتم تطبيق تغييراتي” أعلاه).
لنستعرض كيفية عمل هذا:
-
يتم تنفيذ ملفات JavaScript الموضوعة في
assets/javascripts/discourse/initializersتلقائيًا عند تحميل تطبيق Discourse. -
هذا الملف المعين
exports كائنًا واحدًا، يحتوي على خاصيةnameودالةinitialize. -
يجب أن تكون قيمة
nameفريدة، لذا أطلقت عليها ببساطةalert. -
يتم استدعاء الدالة
initialize()عند تحميل التطبيق. في حالتنا، كل ما تفعله هو تنفيذ كودalert()الخاص بنا.
تحميل البيانات مسبقًا للواجهة الأمامية (Frontend)
استخدم register_preloaded_data في plugin.rb لتضمين البيانات في استجابة HTML الأولية دون الحاجة إلى طلب إضافي:
after_initialize do
register_preloaded_data("visibility") do |guardian|
{ can_access: guardian.authenticated? }
end
end
تضيف النواة (Core) بادئة مفتاح البيانات إلى بيانات وصف الإضافة # name:. للإضافة basic-plugin أعلاه، اقرأ القيمة المحللة في مهيئ الواجهة الأمامية (frontend initializer) باستخدام:
import PreloadStore from "discourse/lib/preload-store";
const visibility = PreloadStore.get("basic-plugin:visibility");
يتم تنفيذ الكتلة (block) لكل تحميل صفحة يعرض تخطيط التطبيق، وتتلقى الـ Guardian الخاص بالطلب، وتعيد قيمة قابلة للترميز إلى JSON. هذه القيم منفصلة عن حمولة الموقع المخزنة مؤقتًا للزوار المجهولين (anonymous site payload). أعد nil لحذف مدخل من السجل؛ سيتم تضمين false. يتم تخطي كتل الإضافات المعطلة. قم بتقييد البيانات الحساسة للمستخدم الطالب من خلال الـ Guardian.
أنت الآن مطور إضافات رسمي لـ Discourse!
المزيد من السلسلة
الجزء 1: هذا الموضوع
الجزء 2: Plugin Outlets
الجزء 3: إعدادات الموقع
الجزء 4: إعداد git
الجزء 5: واجهات المسؤول
الجزء 6: اختبارات القبول
الجزء 7: نشر إضافتك
هذا المستند خاضع لإصدار التحكم بالإصدارات - اقترح التغييرات على GitHub.

