صفحة الصنف `Module` في روبي

الوحدات (كائنات Module) هي مجموعة من التوابع والثوابت. التوابع الموجودة في الوحدات قد تكون إما توابع نسخة (instance methods)، أو توابع وحدة (module methods). توابع النسخة تظهر كتوابع في صنف عند تضمين الوحدة، وذلك على خلاف توابع الوحدة. وبالعكس ، يمكن استدعاء توابع الوحدة دون إنشاء كائن يُغلفها، بينما قد لا يمكن ذلك مع توابع النسخ. انظر صفحة module_function.

في الأمثلة الموجودة في صفحات التوابع، الوسيط sym يشير إلى رمز، والذي قد يكون إما سلسلة نصية، أو كائنا من النوع Symbol (مثل ‎:name).

module Mod
  include Math
  CONST = 1
  def meth
    #  ...
  end
end
Mod.class              #=> Module
Mod.constants          #=> [:CONST, :PI, :E]
Mod.instance_methods   #=> [:meth]

توابع الصنف العامة (Public Class Methods)

التابع constants

يعيد مصفوفة مكونة أسماء كل الثوابت التي يمكن الوصول إليها لحظة الاستدعاء.

التابع nesting

يعيد قائمة من الوحدات (Modules) المتشعبة لحظة الاستدعاء.

التابع new

ينشئ وحدة مجهولة (anonymous module) جديدة.

التابع used_modules

يعيد مصفوفة تحتوي جميع الوحدات (constant) المستخدمة في النطاق الحالي.

توابع النسخة العامة (Public Instance Methods)

التابع ‎<‎

يعد القيمة true إن كان الوسيط mod صنفًا فرعيا من other. أو يعيدnil إن لم تكن بينهما أي علاقة.

التابع ‎<=‎

يعيد القيمة true إن كان الوسيط mod صنفًا فرعيًا من other أو كان يساويه. أو يعد nil إذا لم تكن بينهما أي علاقة.

التابع <=>

يجري عملية المقارنة.

التابع ==

معامل التساوي.

التابع ===

يعيد القيمة true إن كان الوسيط obj نسخة (instance ) من الوسيط mod أو من أحد الأصناف المنحدرة منه.

التابع ‎>‎

يعيد القيمة true إن كان الوسيط mod سلفًا (ancestor) للوسيط other. أو يعيد القيمة nil إن لم تكن بينهما أي علاقة

التابع ‎>=‎

يعيد القيمة true إن كان الوسيط mod سلفًا (ancestor) للوسيط other، أو إن كانت الوحدتان متساويتين. يعيد القيمة nil إن لم تكن بينها أي علاقة.

التابع alias_method

يجعل الوسيط new_name نسخة جديدة من التابع old_name.

التابع ancestors

يعيد قائمة مكونة الوحدات المُتضمنة / المضافة إلى الوحدة (بما في ذلك الوحدة نفسها).

التابع append_features

عندما تكون هذه الوحدة مُضمّنة في وحدة أخرى، فستستدعي روبي append_features في هذه الوحدة،

التابع attr

الشكل الأول مكافئ لـ attr_reader. أما الشكل الثاني فيكافئ attr_accessor(name).

التابع attr_accessor

يحدد خاصية مسماة (named attribute) لهذه الوحدة.

التابع attr_reader

ينشئ متغيرات نسخ (instance variables) والتوابع المقابلة التي تعيد قيمة كل متغير نسخ.

التابع attr_writer

ينشئ التابع attr_writer مدخلًا (accessor method) للسماح بتعيين قيم الخاصية symbol.id2name.

التابع autoload

يُُسجل اسم الملف المراد تحميله (باستخدام Kernel::require) في أول مرة يتم فيها الدخول إلى الوحدة.

التابع autoload?‎

يعيد اسم الملف الذي سيُحمل إن كان الوسيط المعطى مسجلًا كـ autoload في مجال أسماء الوحدة.

التابع class_eval

يُقبّم السلسلة النصية أو الكتلة المعطاة في سياق الوحدة.

التابع class_exec

يقيم الكتلة المعطاة في سياق الصنف/الوحدة.

التابع class_variable_defined?

يعيد القيمة true إن كان متغير الصنف (class variable) المعطى مٌعرّفا في الوسيط obj.

التابع class_variable_get

يعيد قيمة متغير الصنف المعطى (أو يطلق استثناء NameError).

التابع class_variable_set

يضبط قيمة متغير الصنف المحدد بالوسيط symbol ويحيل إليه الكائن المعطى obj.

التابع class_variables

يعيد مصفوفة مكونة من أسماء متغيرات الصنف في الوحدة.

التابع const_defined?

يتحقق التابع const_defined?‎ مما إذا كانت الوحدة التي استُدعي معها أو أحد أسلافها (ancestors) تحتوي الثابت المعطى.

التابع const_get

يتحقق من وجود ثابت بالاسم المحدد في الوحدة.

التابع const_missing

يُستدعى عند محاولة استخدام ثابت غير معرف في الوحدة.

التابع const_set

يضبط قيمة الثابت المعطى عند الكائن المحدد.

التابع constants

يعيد مصفوفة من أسماء كل الثوابت التي يمكن الوصول إليها لحظة الاستدعاء.

التابع define_method

يعرف تابع النُسخ (instance method) في المُستقبِل (receiver).

التابع deprecate_constant

يضع قائمة بالثوابت الموجودة المُتجاوزة.

التابع extend_object

يوسع الكائن المعطى بإضافة ثوابت و توابع هذه الوحدة.

التابع extended

يكافئ included، إلا أنه يُستخدم مع الوحدات الموسعة (extended modules).

التابع freeze

يمنع إجراء المزيد من التعديلات على الوحدة.

التابع include

يستدعي التابع Module.append_features على كل الوسائط الممررة بترتيب عكسي.

التابع include?

يعيد القيمة true إن كانت الوحدة المعطاة module مُضمّنة في الوحدة أو أحد أسلافها (ancestors).

التابع included

يُستدعى في كل مرة يتم تضمين المتلقي (receiver) في وحدة أو صنف آخر.

التابع included_modules

يعيد قائمة بالوحدات المضمنة في الوحدة.

التابع inspect

inspect هو اسم آخر للتابع to_s.

التابع instance_method

يعيد التابع instance_method كائن UnboundMethod يمثل تابع النسخة (instance method) المعطى في الوحدة التي استُدعي معها.

التابع instance_methods

يعيد مصفوفة تحتوي على أسماء توابع النسخ (instance methods) العامة والمحمية (protected) في المستقبِل (receiver).

التابع constants

يعيد التابع constants مصفوفة من أسماء كل الثوابت التي يمكن الوصول إليها من الوحدة.

التابع method_added

يُستدعى في كل مرة يُضاف تابع نسخة (instance method) إلى المُستقبِل (receiver).

التابع method_defined?

يعيد القيمة true إن كان التابع المعطى مُعرّفا في الوحدة أو الصنف (أو الوحدات المُتضمنة فيه، وإن كان صنفًا فأسلافه).

التابع method_removed

يستدعى في كل مرة يُزال تابع نسخة (instance method) من المُستقبِل (receiver).

التابع module_eval

يُقيّم السلسلة النصية أو الكتلة المعطاة في سياق الوحدة،

التابع module_exec

يقيّم الكتلة الممررة في سياق الصنف/الوحدة.

التابع module_function

ينشئ دوال وحدة (module functions) للتابع المعطى.

التابع name

يعيد اسم الوحدة. أو يعيد القيمة nil إن كانت الوحدات مجهولة (anonymous modules).

التابع prepend

يستدعي التابع Module.prepend_features على كل الوسائط المعطاة بترتيب عكسي.

التابع prepend_features

عندما تُرفق هذه الوحدة مع أخرى، تستدعي روبي التابع prepend_features في هذه الوحدة.

التابع prepended

يكافئ included ، ولكنه للوحدات المُرفقة (prepended modules).

التابع private

إذا استُدعي التابع private دون إعطائه وسائط، فسيُعيّن المنظورية (visibility) الافتراضية للتوابع المحددة لاحقًا عند القيمة private. أما في حال تمرير وسائط، فسيضبط منظورية التوابع عند القيمة private. تُحوّل الوسائط النصية String إلى رموز.

التابع private_class_method

يجعل توابع الصف الحالية خاصة (private).

التابع private_constant

يجعل قائمة الثوابت الموجودة الخاصة.

التابع private_instance_methods

يعيد قائمة بتوابع النسخة (instance methods) الخاصة (private) المعرفة في mod.

التابع private_method_defined?‎

يعيد القيمة true إن كان التابع الخاص المعطى معرفًا من طرف _ mod_.

التابع protected

يضبط المنظورية (visibility) الافتراضية للتوابع عند القيمة protected.

التابع protected_instance_methods

يعيد التابع protected_instance_methods قائمة بتوابع النسخة (instance methods) المحمية المعرفة في الوحدة. إذا كان الوسيط الاختياري يساوي false ، فلن تُتضمّن توابع الأسلاف (ancestors).

التابع protected_method_defined?‎

يعيد التابع protected_method_defined?‎ القيمة true إن كان التابع المحمي (protected) المعطى معرفًا في الوحدة (أو الوحدات المُتضمنة فيه، أو أسلافه إن كان صنفًا).

التابع public

في حال استدعاء التابع public بدون وسائط، فسيضبط المنظورية (visibility) الافتراضية للتوابع المعرفة لاحقًا عند القيمة public. أما في حال تمرير وسائط، فسيضبط منضورية التوابع المعطاة عند القيمة public.