الصنف Module في روبي

من موسوعة حسوب
اذهب إلى: تصفح، ابحث

الصنف 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

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

()constants

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

nesting

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

new

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

used_modules

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

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

‎<‎

يعيد المعامل ‎<‎ القيمة true إن كانت الوحدة Module التي تقع على يساره صنفًا فرعيًّا من الوحدة التي تقع على يمينه، أو يعيد القيمة nil إن لم تكن بينهما أية علاقة.

‎<=‎

يعيد المعامل ‎<=‎ القيمة true إن كانت الوحدة Module التي تقع على يساره صنفًا فرعيًّا من الوحدة التي تقع على يمينه أو كانت الوحدتان متساويتين تمامًا، أو يعيد القيمة nil إذا لم تكن بينهما أية علاقة.

<=>

يجري المعامل <=> عملية الموازنة بين كائنين ثم يعيد الناتج الذي يشير إلى العلاقة بينهما.

==

يتحقق معامل التساوي == من تساوي كائنين.

===

يعيد المعامل === القيمة true إن كان الكائن الواقع على يمينه نسخةً (instance ) من الكائنModule الواقع على يمينه أو من أحد الأصناف المنحدرة منه.

‎>‎

يعيد المعامل < القيمة true الكائن Module الذي يقع على يساره سلفًا (ancestor) للكائن الذي يقع على يمينه، أو يعيد القيمة nil إن لم تكن بينهما أية علاقة.

‎>=‎

يعيد المعامل ‎>=‎‎ القيمة true إن كانت الوحدة Module التي تقع على يساره سلفًا (ancestor) للوحدة التي تقع على يمينه أو إن كانت الوحدتان متساويتين، أو يعيد القيمة nil إن لم تكن بينها أي علاقة.

alias_method

ينشئ اسمًا جديدًا (بديلًا) لتابع محدَّد.

ancestors

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

attr

يكافئ التابع attr_reader.

attr_accessor

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

attr_reader

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

attr_writer

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

autoload

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

autoload?‎

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

class_eval

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

class_exec

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

?class_variable_defined

يتحقق إن كان متغير الصنف (class variable) المعطى مٌعرّفا في الكائن الذي استُدعي معه.

class_variable_get

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

class_variable_set

يضبط قيمة متغير الصنف المحدد بالمعامل المُمرَّر ويحيل إليه قيمة محدَّدة.

class_variables

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

?const_defined

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

const_get

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

const_missing

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

const_set

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

constants

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

define_method

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

deprecate_constant

ينشئ قائمة بالثوابت الموجودة المهملة.

freeze

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

include

يستدعي التابع append_features على كل المعاملات المُمرَّرة بترتيب عكسي.

?‎include

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

included_modules

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

inspect

هو اسم بديل للتابع to_s.

instance_method

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

instance_methods

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

constants

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

?method_defined

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

module_eval

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

module_exec

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

name

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

prepend

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

private_class_method

يجعل توابع صنفٍ محدَّدٍ خاصة (private).

private_constant

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

private_instance_methods

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

private_method_defined?‎

يتحقق إن كان التابع الخاص (private) المعطى معرَّفًا من قِبَل _ mod_ (أو الوحدات المتضمنة فيه، وأسلافه [ancestors] إن كان صنفًا).

protected_instance_methods

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

protected_method_defined?‎

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

public_class_method

ينشئ قائمةً بتوابع الصنف العامة الحالية.

public_constant

ينشئ قائمةً بالثوابت العامة الموجودة.

public_instance_method

يبحث عن التوابع العامة (public) وحسب على غرار التابعinstance_method.

public_instance_methods

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

public_method_defined?‎

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

remove_class_variable

يزيل تعريف متغير محدَّد من صنفٍ ثم يعيد قيمة ذلك الثابت.

remove_method

يزيل تابعًا ذا اسم محدَّد من الصنف الحالي.

singleton_class?‎

يتحقق إن كان الصنف الذي استُدعي معه صنفا مفردًا (singleton class).

to_s

يعيد سلسلة نصية تمثل الوحدة أو الصنف الذي استدعي معه. 

undef_method

يمنع الصنف الحالي من الاستجابة للاستدعاءات الموجهة إلى التابع المعطى. 

توابع النسخة الخاصة (Private Instance Methods)

append_features

عندما تكون هذه الوحدة مُضمّنة في وحدة أخرى، فستستدعي روبي التابع append_features في هذه الوحدة، وتمرر إليه الوحدة المستقبلة (receiving module) التي استُدعيت معه.

extend_object

يوسع الكائن المعطى بإضافة ثوابت و توابع هذه الوحدة (والتي تُضاف كتوابع فردية [singleton methods]).

extended

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

included

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

method_added

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

method_removed

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

method_undefined‎

غير موثَّق بعد.

module_function

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

prepend_features

يُستدعَى في الوحدة المعطاة عندما تُرفق هذه الوحدة في أخرى، وتُمرَّر إليها الوحدة المُستقبِلة (receiving module) في الوحدة التي مُمرِّرت إليه.

prepended

يكافئ التابع included باستثناء أنَّه مخصص للوحدات المُرفقة (prepended modules).

private

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

protected

يعين المرئية (visibility) الافتراضية للتوابع المعرفة لاحقًا إلى المرئيةprotected المحمية إن لم يمُرَّر إليه أي شيء. أما في حال تمرير اسم تابع (أو عدة توابع إليه)، فسيضبط مرئية هذه التوابع المرئية protected المحمية. 

public

يعين المرئية (visibility) الافتراضية للتوابع المعرفة لاحقًا إلى public العامة إن لم يمُرَّر إليه أي شيء. أما في حال تمرير اسم تابع (أو عدة توابع إليه)، فسيضبط مرئية هذه التوابع المرئية public العامة. 

refine

يحسِّن (refine) الوحدة المستقبلة (receiver) ثم يعيد الوحدة التي عُرِّفت فيهاالتوابع المحسَّنة.

remove_const

يزيل تعريف ثابت محدَّد، ويعيد القيمة السابقة له.

using

يستورد الأصناف المحسَّنة (class refinements) من الوحدة المٌمررة إليه إلى التعريف الحالي للصنف أو الوحدة.

مصادر